Sign in

v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Payouts

Check a payout

Verifies the details of a payout request, including the amount, currency, beneficiary, rate, source of funds, and fee handling method, before execution.

post/open-api/v3/payment/validate-parameters

Request body

accountIdstring required

The UUID of the account.

clientTransactionIdstring uuid required

Universally unique identifier (UUID v4) client transaction id. This key is utilized to ensure exactly-once execution of mutating requests.

rateIdstring required

Rate id

payeeIdstring required

Beneficiary ID

balanceIdstring required

A source of funds.

memostring

Transfer remarks and remarks

reasonstring

Reason and purpose, Deprecated

purposeIdstring

ID of the payout purpose, obtained from the /purposes endpoint.

amountstring required

Amount.

amountType'PAY' | 'COLLECT' required

With the amount and currency, either the payment amount or the received amount can be used to verify the payout.

feeMode'OUR' | 'SHA' required

Handling fee bearing method:

  • OUR: The payer bears all fees, and the beneficiary receives the full amount.
  • SHA: The payer and the beneficiary share the fees. The beneficiary will receive the amount minus the beneficiary bank's charges. Note: This field is mandatory for SWIFT transfers.

Example request

{
  "amount": "200.0"
}

Response

OK

codestring

Error code

messagestring

Error message

Example response

{
  "code": "400001",
  "message": "Invalid parameter"
}