v1

latestOpenAPI 3.0.02026-07-14866188.2 KB

Redeem

Redeem airtime.

post/v0.2.4/redeem/airtime

Request body

subAccountstring

Subaccount if any.

chiRefstring required

Chi reference.

phoneNumberstring required

Phone number.

countryToSendstring required

Country to send to.

Example request

{
  "subAccount": "1234567",
  "chiRef": "1234567",
  "phoneNumber": "+2341234567",
  "countryToSend": "Nigeria",
  "meta": {
    "test": true
  }
}

Response

Success.

statusstring

messagestring

Example response

{
  "status": "success",
  "message": "Airtime redeemed successfully",
  "data": {
    "payoutLink": "http://localhost:4000/pay/?issueID=eaabe2eb-e774-4f81-8ba9-ede2ea2d0058_10_1726494779981",
    "data": {
      "id": "KGiwpulQZHnanhNnCEak",
      "valueInUSD": 10,
      "chimoney": 10000,
      "issueID": "eaabe2eb-e774-4f81-8ba9-ede2ea2d0058_10_1726494779981",
      "type": "api-payment",
      "subAccount": "eaabe2eb-e774-4f81-8ba9-ede2ea2d0058",
      "issuer": "eaabe2eb-e774-4f81-8ba9-ede2ea2d0058",
      "t_id": 89448,
      "chiRef": "e8bb27c9-7e6d-4734-b242-36efbd5f8f5c",
      "meta": {},
      "integration": {
        "appID": "TyGlLVepVqfOj3635qrC"
      },
      "issueDate": "2024-09-16T13:53:00.806Z",
      "payerEmail": "favour@chimoney.io",
      "redirect_url": "https://test.com",
      "redeemData": {
        "walletID": "6ShqiB470pYLLgFE1Duc"
      },
      "initiatedBy": "1d812de4-b5e3-474b-9572-19667eb985f3",
      "updatedDate": "2024-09-16T13:54:52.078Z",
      "paymentDate": "2024-09-16T13:54:52.077Z",
      "status": "paid"
    },
    "error": "None",
    "payouts": [
      {
        "amount": "NGN 15827.6000",
        "discount": "NGN 316.5520",
        "errorMessage": "None",
        "phoneNumber": "+2348056849366",
        "requestId": "ATQid_c6456457b765be56bf8d5a9d6c22a3ac",
        "status": "Sent"
      }
    ]
  }
}