Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Payouts

Payout Airtime to a Phone number.

post/v0.2.4/payouts/airtime

Request body

subAccountstring

Subaccount (Wallet Account) to payout from, if any.

turnOffNotificationboolean

disables email and other notifications from Chimoney.

Example request

{
  "subAccount": "1234567",
  "airtimes": [
    {
      "countryToSend": "Nigeria",
      "phoneNumber": "+2341000000000",
      "valueInUSD": 5,
      "narration": "Monthly Airtime",
      "collectionPaymentIssueID": "1209992222"
    }
  ]
}

Response

Success.

statusstring

Status of the request.

messagestring

message of the request.

Example response

{
  "status": "success",
  "message": "Airtime Payout is successfull",
  "data": {
    "payoutLink": "undefined/pay/?issueID=XQTUvRBntIU3AHgQ3jFuN9ZcHIC3_1_1661114934226",
    "error": "None"
  }
}