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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The UUID of the account.

uuid
required

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

string
required

Rate id

string
required

Beneficiary ID

string
required

A source of funds.

string

Transfer remarks and remarks

string
deprecated

Reason and purpose, Deprecated

string

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

string
required

Amount.

string
enum
required

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

Allowed:
string
enum
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.
Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json