Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Payouts

Initiate Chimoney transaction.

post/v0.2.4/payouts/initiate-chimoney

Request body

subAccountstring

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

turnOffNotificationboolean

disables email and other notifications from Chimoney.

redirect_urlstring

url to redirect to after payment is confirmed

debitCurrencystring

Wallet Currency to debit from.

enableXUMMPaymentboolean

Generate a Xumm transaction sign link

enableInterledgerPaymentboolean

Generate an Open Payment payment request to pay with Interledger

Example request

{
  "subAccount": "1234567",
  "redirect_url": "https://example.com/confirm",
  "debitCurrency": "CAD",
  "chimoneys": [
    {
      "email": "test@gmail.com",
      "phone": "+16471112222",
      "valueInUSD": 10,
      "amount": 10,
      "twitter": "@test",
      "redeemData": {
        "walletID": "XQTUvRBntIU3AHgQ3jFuN9ZcHIC3",
        "interledgerWalletAddress": "https://ilp.chimoney.com/uchi",
        "account_bank": "044",
        "account_number": "0690000031",
        "currency": "NGN",
        "branch_code": "GH190101",
        "fullname": "Jane Doe"
      }
    }
  ],
  "cryptoPayment": [
    {
      "xrpl": {
        "address": "0x1234567890",
        "issuer": "issuer",
        "currency": "currency"
      }
    }
  ]
}

Response

Success.

statusstring

Status of the request.

messagestring

Message describing the outcome.

Example response

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