v1

latestOpenAPI 3.0.02026-07-14866188.2 KB

Redeem

Redeem mobile money.

post/v0.2.4/redeem/mobile-money

Request body

subAccountstring

Subaccount if any.

chiRefstring required

Chi reference.

Example request

{
  "subAccount": "69791840-4f46-4e97-b6fd-b411bde50202",
  "chiRef": "27583029-145b-4575-a608-0fbf655a0f2a",
  "redeemOptions": {
    "phoneNumber": "+2248123388400",
    "countryToSend": "Kenya",
    "momoCode": "MPS"
  }
}

Response

Success.

statusstring

messagestring

Example response

{
  "status": "success",
  "message": "Mobile money redeemed successfully",
  "data": {
    "payoutLink": "http://localhost:4000/pay/?issueID=69791840-4f46-4e97-b6fd-b411bde50202_10_1723717712329",
    "error": "None",
    "id": 648221,
    "account_number": "2248123388400",
    "bank_code": "MPS",
    "full_name": "NOT PROVIDED",
    "created_at": "2024-08-15T12:22:56.000Z",
    "currency": "KES",
    "debit_currency": "USD",
    "amount": 1302.2987,
    "status": "NEW",
    "reference": "27583029-145b-4575-a608-0fbf655a0f2a_1723724574832",
    "meta": [
      {
        "Sender": "Uchi Uchibeke",
        "EmailAddress": "support@chimoney.io",
        "MobileNumber": "16479330835",
        "SenderCountry": "CA",
        "SenderIdType": "04",
        "SenderIdNumber": "1204939024"
      }
    ],
    "narration": "Chi: 27583029-145b-4575-a608-0fbf655a0f2a",
    "is_approved": 1,
    "bank_name": "FA-BANK"
  }
}