Skip to main content
GET
Retrieve 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.

Path Parameters

payout_id
string
required

Payout order ID

Example:

"PO1234567890123456789"

Response

200 - application/json

Payout retrieved successfully

payout_id
string
required

Payout UUID

Example:

"PO1968582687224500224"

payout_currency
string
required

Three-letter currency code

Example:

"SGD"

payout_amount
string
required

The payout amount submitted in the request.

Example:

"100.00"

payout_fee
string
required

The fee charged for the payout, denominated in payout_currency.

debited_amount
string
required

The total amount debited from your balance.

  • Fee deducted from the payout: debited_amount = payout_amount
  • Fee charged separately: debited_amount = payout_amount + payout_fee
transfer_amount
string
required

The amount sent to the downstream payout provider.

  • Fee deducted from the payout: transfer_amount = payout_amount - payout_fee
  • Fee charged separately: transfer_amount = payout_amount
statement_descriptor
string
required

Payout reference information displayed to the recipient's bank

Maximum string length: 15
Example:

"UQPAY PAYOUT"

payout_status
enum<string>
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.
Available options:
INITIATED,
PROCESSING,
COMPLETED,
FAILED,
FAILED_REFUNDED
Example:

"INITIATED"

create_time
string<date/time>
required

Payout creation time

Example:

"2025-09-18T15:47:41+08:00"

internal_note
string

Payout remark information

Example:

"Payment to supplier"

completed_time

Payout completion time. An empty string means no completion time is available.

Example:

""