Skip to main content
GET
Validate payout

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPAY.

Headers

x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Query Parameters

beneficiary_id
string
required
currency
string
required
amount
string
required
fee_paid_by
enum<string>
required
Available options:
OURS,
SHARED

Response

Payout validation result.

currency
string
amount
string
fee_amount
string
total_amount
string
channel_code
string

Channel selected by the server. This is not a Create Payout request parameter.

sufficient_funds
boolean
beneficiary_valid
boolean