v1

latestOpenAPI 3.0.02026-07-14866188.2 KB

Payouts

Payout Giftcards to an email.

post/v0.2.4/payouts/gift-card

Request body

subAccountstring

Subaccount (Wallet Account) to payout from, if any.

turnOffNotificationboolean

disables email and other notifications from Chimoney.

Example request

{
  "subAccount": "000022d0-fe5f-4813-a5cf-e45e8be1111",
  "giftcards": [
    {
      "email": "test@gmail.com",
      "valueInUSD": 10,
      "narration": "Monthly Gift card reward",
      "collectionPaymentIssueID": "1209992222",
      "redeemData": {
        "productId": "1800FL-US",
        "countryCode": "US",
        "valueInLocalCurrency": 10
      }
    }
  ]
}

Response

Success.

statusstring

Status of the request.

messagestring

Message describing the outcome.

Example response

{
  "status": "success",
  "message": "Chimoney payout to gift cards completed successfully",
  "data": {
    "chimoneys": [
      {
        "id": "voDK37Kj6g8v6OpMPolr",
        "valueInUSD": 10,
        "chimoney": 10000,
        "issueID": "63576330-b5f6-4279-9324-80633ce14710_10_1726569689832",
        "productId": "ZAPPO-US",
        "personalizedMessage": "Monthly Gift card reward",
        "fee": 1,
        "type": "giftcard",
        "issuer": "63576330-b5f6-4279-9324-80633ce14710",
        "enabledToRedeem": [
          "giftcard"
        ],
        "valueInLocalCurrency": 10,
        "t_id": 846858,
        "chiRef": "4a3e61a3-ced8-4a48-a35d-02329ecbd2ad",
        "countryCode": "US",
        "narration": "Monthly Gift card reward",
        "integration": {
          "appID": "rCh0APD3W3V7SE4EDVn6"
        },
        "issueDate": "2024-09-17T10:41:37.326Z",
        "email": "test@gmail.com",
        "redeemData": {
          "valueInLocalCurrency": 10,
          "productId": "ZAPPO-US",
          "countryCode": "US"
        },
        "initiatedBy": "qP3P6bjbjLZUMxVfxgEqzOF0hNM2",
        "status": "redeemed"
      }
    ]
  }
}