Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Redeem

Redeem Chimoney.

post/v0.2.4/redeem/chimoney

Request body

subAccountstring

Subaccount associated with the transaction, if any.

turnOffNotificationboolean

Option to turn off notifications for this redemption. Defaults to false.

Example request

{
  "subAccount": "69791840-4f46-4e97-b6fd-b411bde50202",
  "chimoneys": [
    {
      "valueInUSD": "5",
      "email": "ogedifavo@gmail.com"
    }
  ]
}

Response

Success.

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Chimoney redeemed successfully",
  "data": {
    "paymentLink": "http://localhost:4000/pay/?issueID=69791840-4f46-4e97-b6fd-b411bde50202_5_1726496063760",
    "data": [
      {
        "id": "Es2SI02XwLHBFFT3MTHF",
        "t_id": 34854,
        "valueInUSD": "5",
        "chimoney": 5000,
        "issueID": "69791840-4f46-4e97-b6fd-b411bde50202_5_1726496063760",
        "chiRef": "0a6eef6c-3c38-4a3a-8b1e-2c46e63ac9d2",
        "fee": 1,
        "type": "chimoney",
        "issueDate": "2024-09-16T14:14:27.283Z",
        "email": "ogedifavo@gmail.com",
        "issuer": "69791840-4f46-4e97-b6fd-b411bde50202",
        "status": "unpaid",
        "redeemLink": "http://localhost:4000/redeem/?chi=0a6eef6c-3c38-4a3a-8b1e-2c46e63ac9d2"
      }
    ],
    "error": "None"
  }
}