Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Payment Payouts

Create Payout

Create a new payout order

post/v2/payment/payout/create

Headers

x-on-behalf-ofstring

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 API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring uuid

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.

Request body

payout_currencystring required

Three-letter currency code

payout_amountstring required

The amount to be withdrawn through this payout.

internal_notestring

Payout remark information

statement_descriptorstring required

Payout reference information displayed to the recipient's bank

payout_account_idstring

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.

Example request

{
  "payout_amount": "100.00",
  "internal_note": "Payment to supplier",
  "statement_descriptor": "UQPAY PAYOUT",
  "payout_account_id": "18523f72-f4de-4f9c-bb8e-ec7d1c4f32be"
}

Response

Payout created successfully

payout_idstring required

Payout UUID

payout_currencystring required

Three-letter currency code

payout_amountstring required

The amount to be withdrawn through this payout.

internal_notestring

Payout remark information

statement_descriptorstring required

Payout reference information displayed to the recipient's bank

payout_status'INITIATED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'FAILED_REFUNDED' required

Payout status enumeration.

  • INITIATED: Payout has been initiated.
  • PROCESSING: Payout is being processed (bank is processing).
  • COMPLETED: Payout completed successfully.
  • FAILED: Payout failed.
  • FAILED_REFUNDED: Payout failed and funds have been refunded.
create_timestring date/time required
completed_timestring date/time

Example response

{
  "payout_id": "PO1968582687224500224",
  "payout_amount": "100.00",
  "internal_note": "Payment to supplier",
  "statement_descriptor": "UQPAY PAYOUT",
  "payout_status": "INITIATED",
  "create_time": "2024-03-01T00:00:00+08:00",
  "completed_time": "2024-03-01T00:00:00+08:00"
}