Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Redeem

Redeem any.

post/v0.2.4/redeem/any

Request body

subAccountstring

Subaccount if any.

chiRefstring required

Chi reference.

redeemDataobject required

Data needed to redeem. See examples in body.

Example request

{
  "subAccount": "1234567",
  "chiRef": "1234567",
  "meta": {
    "test": true
  },
  "redeemData": {
    "countryCode": "US",
    "productId": "5",
    "email": "test@gmail.com"
  }
}

Response

Success.

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Redeemed successfully",
  "data": {
    "payoutLink": "http://localhost:4000/pay/?issueID=eaabe2eb-e774-4f81-8ba9-ede2ea2d0058_5_1726506283562",
    "error": "None",
    "timeStamp": "2024-09-16 17:12:21",
    "path": "/orders",
    "errorCode": "INVALID_INPUT_PROVIDED",
    "details": []
  }
}