v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Redeem

Redeem giftcard.

post/v0.2.4/redeem/gift-card

Request body

subAccountstring

Subaccount if any.

chiRefstring required

Chi reference.

Example request

{
  "subAccount": "1234567",
  "chiRef": "1234567",
  "redeemOptions": {
    "email": "test@gmail.com",
    "countryCode": "+234",
    "productId": "2334"
  }
}

Response

Successfully redeemed gift card.

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Gift card redeemed successfully",
  "data": {
    "id": "APCPpcya0vyxtT6cHarp",
    "valueInUSD": 10,
    "chimoney": 10000,
    "issueID": "69791840-4f46-4e97-b6fd-b411bde50202_10_1723654027431",
    "type": "api-payment",
    "subAccount": "69791840-4f46-4e97-b6fd-b411bde50202",
    "issuer": "69791840-4f46-4e97-b6fd-b411bde50202",
    "t_id": 429775,
    "chiRef": "20091480-8f61-43d6-b2ec-97de96c21d01",
    "meta": {},
    "integration": {
      "appID": "rCh0APD3W3V7SE4EDVn6"
    },
    "issueDate": "2024-08-14T16:47:08.253Z",
    "payerEmail": "favour@chimoney.io",
    "redirect_url": "https://test.com",
    "redeemData": {
      "walletID": "bFQntsPMWtfg0MQ5r911"
    },
    "initiatedBy": "qP3P6bjbjLZUMxVfxgEqzOF0hNM2",
    "updatedDate": "2024-08-14T16:47:29.320Z",
    "paymentDate": "2024-08-14T16:47:29.320Z",
    "status": "paid",
    "walletID": "bFQntsPMWtfg0MQ5r911",
    "email": "ogedifavour2@gmail.com"
  }
}