v1

latestOpenAPI 3.0.02026-07-14866188.2 KB

Payouts

Interledger

Payout to a Interledger Wallet Address.

post/v0.2.4/payouts/interledger-wallet-address

Request body

subAccountstring

Subaccount (Wallet Account) to payout from if any.

turnOffNotificationboolean

disables email and other notifications from Chimoney.

debitCurrencystring

Wallet Currency to debit from to settle the amountToDeliver values.

Example request

{
  "subAccount": "1234567",
  "debitCurrency": "CAD",
  "interledgerWallets": [
    {
      "interledgerWalletAddress": "https://ilp-sandbox.chimoney.com/username",
      "currency": "USD",
      "amountToDeliver": 10,
      "amount": 200,
      "valueInUSD": 2500,
      "narration": "Interledger Salary Payment",
      "collectionPaymentIssueID": "1209992222"
    }
  ]
}

Response

Success.

statusstring

Status of the request.

messagestring

Message of the request.

Example response

{
  "status": "success",
  "message": "Payout to Chimoney wallets completed successfully.",
  "data": {
    "paymentLink": "undefined/pay/?issueID=XQTUvRBntIU3AHgQ3jFuN9ZcHIC3_2_1661118346647",
    "error": "None",
    "payouts": {
      "issueID": "eaabe2eb-e774-4f81-8ba9-ede2ea2d0058_11_1726579317119"
    }
  }
}