Redeem any.

This endpoint allows you to redeem any transaction ( chimoney , giftcard, momo ).

📘

chiRef is required

chiRef is a reference to a previously initiated transaction on Chimoney API. meta contains metadata you want to be associated to this transaction/ redeem action. Check out the Knowing The API section of the documentation for more information.

Redeem already paid for Chimoney programmatically to any of the supported options instead of from dash.chimoney.io/redeem.

chiRef is required.

redeemData is required

Depending on what you want to redeem, the redeemData fields will be different

Redeem to Wallet - RedeemData Field

{
  "chiRef": "009-0khfkmfmkfk-ueuuakak1",
  "enabledToRedeem": ["wallet"],
  "type": "wallet",
  "redeemData": {
      "walletID":"0khfkmfmkfk"
  }
}

Redeem Mobile Money - RedeemData Field

{
  "chiRef": "009-0khfkmfmkfk-ueuuakak1",
  "redeemData": {
      "country":"Kenya",
      "momoCode":"0khfkmfmkfk",,
      "phoneNumber": "+256789868011"
  }
}

Redeem Gift Card - RedeemData Field

{
  "chiRef": "0khfkmfmkfk",
  "redeemData": {
    "countryCode": "US",
    "productId": "1"
  }
}

Redeem To Bank - RedeemData Field

{
  "chiRef": "0khfkmfmkfk",
  "redeemData": {
    "currency": "NGN",
    "account_bank": "11111",
    "account_number": "1234567890",
    "fullname": "Last First"
  }
}

Get Country Bank Codes from /info/country-banks?countryCode=NG

Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!