v1

latestOpenAPI 3.0.02026-07-14866188.2 KB

Payouts

Payout Chimoney.

post/v0.2.4/payouts/chimoney

Request body

subAccountstring

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

turnOffNotificationboolean

disables email and other notifications from Chimoney.

Example request

{
  "subAccount": "1234567",
  "chimoneys": [
    {
      "email": "test@gmail.com",
      "phone": "+16471112222",
      "valueInUSD": 10,
      "amount": 10,
      "currency": "CAD",
      "narration": "Monthly Flex Payment",
      "collectionPaymentIssueID": "1209992222",
      "redeemData": {
        "walletID": "XQTUvRBntIU3AHgQ3jFuN9ZcHIC3",
        "interledgerWalletAddress": "https://ilp.chimoney.io/uchi",
        "beneficiaryId": "Sam-15cc11ef-b5e6-4339-9ece-9c5b0149d"
      }
    }
  ]
}

Response

Success.

statusstring

Status of the request.

messagestring

message of the request.

Example response

{
  "status": "success",
  "message": "Chimoney payout completed successfully",
  "data": {
    "paymentLink": "undefined/pay/?issueID=XQTUvRBntIU3AHgQ3jFuN9ZcHIC3_2_1661118346647",
    "error": "None"
  }
}