v1

latestOpenAPI 3.0.02026-07-14866188.2 KB

Payouts

Check Payout status.

post/v0.2.4/payouts/status

Request body

subAccountstring

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

turnOffNotificationboolean

disables email and other notifications from Chimoney.

chiRefstring required

Chi reference.

Response

Success.

statusstring

Status of the request.

messagestring

Message describing the outcome.

Example response

{
  "status": "success",
  "message": "Chimoney status retrieved successfully.",
  "data": {
    "id": "cINCeQ7XHIDysQv6iHid",
    "valueInUSD": 10,
    "chimoney": 10000,
    "issueID": "4cddf021-e908-4675-9ca3-59ad3b60046d_10_1721586903566",
    "receiver": "63576330-b5f6-4279-9324-80633ce14710",
    "personalizedMessage": "Reward Payment",
    "type": "chimoney",
    "issuer": "4cddf021-e908-4675-9ca3-59ad3b60046d",
    "t_id": 756426,
    "chiRef": "132ca9bb-77a6-4a48-935a-63f4dc0b6686",
    "narration": "Reward Payment",
    "integration": {
      "appID": "rCh0APD3W3V7SE4EDVn6"
    },
    "issueDate": "2024-07-21T18:35:05.847Z",
    "redeemData": {
      "valueInUSD": 10,
      "walletID": "J19pKulPNXNeDSeVAJom",
      "receiver": "63576330-b5f6-4279-9324-80633ce14710",
      "narration": "Reward Payment",
      "redeemData": {}
    },
    "initiatedBy": "qP3P6bjbjLZUMxVfxgEqzOF0hNM2",
    "paymentDate": "2024-07-21T18:35:11.162Z",
    "redeemDate": "2024-07-21T18:35:18.172Z",
    "meta": {
      "walletOwner": "63576330-b5f6-4279-9324-80633ce14710",
      "chiRef": "132ca9bb-77a6-4a48-935a-63f4dc0b6686",
      "currency": "USD",
      "type": "chi",
      "payer": "4cddf021-e908-4675-9ca3-59ad3b60046d",
      "payment_method": "wallet"
    },
    "payout": {
      "wallet": "J19pKulPNXNeDSeVAJom"
    },
    "updatedDate": "2024-07-21T18:35:18.172Z",
    "deliveryStatus": "success",
    "status": "redeemed"
  }
}