GuidesAPI ReferenceChangelog
Log In
API Reference

Create Payout

post
https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create

Create a new payout order

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

Three-letter currency code

string
required

The amount to be withdrawn through this payout.

string

Payout remark information

string
required
length ≤ 15

Payout reference information displayed to the recipient's bank

string

The UQPAY account ID to receive the payout funds via internal transfer. Both long and short account IDs are accepted.

  • If omitted, the payout is sent to the pre-configured external bank account (default behavior).
  • If provided, the payout is processed as a UQPAY internal transfer to the specified account. Pass the account ID of the caller.
Headers
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.

uuid
required

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Responses

Updated 9 months ago

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

Updated 9 months ago