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

id
string<uuid>
required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

Response

200 - application/json

OK - Successfully retrieved a payout.

unique_request_id
string<uuid>
required

Universally unique identifier (UUID v4). This identifier will be used by the client in a POST operation to create the resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

payout_id
string<uuid>
required

Unique identifier for the payout.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

amount_payer_pays
string
required

The amount actually paid by the payer for the payout.

Example:

"1000.00"

payout_currency
string
required

Currency in which money is held in the beneficiary's bank account. Three-letter ISO 4217 currency code.

Required string length: 3
Example:

"USD"

payout_amount
string
required

The amount that the payer will send out, in currency.

Example:

"1000.00"

purpose_code
string
required

Purpose code of payout and must be one of:

  • AUDIO_VISUAL_SERVICES - Audiovisual services.
  • BILL_PAYMENT - Bill payment.
  • BUSINESS_EXPENSES - Business expenses.
  • CONSTRUCTION - Construction.
  • DONATION_CHARITABLE_CONTRIBUTION - Donation/charitable contribution.
  • EDUCATION_TRAINING - Education/training.
  • FAMILY_SUPPORT - Family support.
  • FREIGHT - Freight.
  • GOODS_PURCHASED - Goods purchased.
  • INVESTMENT_CAPITAL - Investment capital.
  • INVESTMENT_PROCEEDS - Investment proceeds.
  • LIVING_EXPENSES - Living expenses.
  • LOAN_CREDIT_REPAYMENT - Loan/credit repayment.
  • MEDICAL_SERVICES - Medical services.
  • PENSION - Pension.
  • PERSONAL_REMITTANCE - Personal remittance.
  • PROFESSIONAL_BUSINESS_SERVICES - Professional/business services.
  • REAL_ESTATE - Real estate.
  • TAXES - Taxes.
  • TECHNICAL_SERVICES - Technical services.
  • TRANSFER_TO_OWN_ACCOUNT - Transfer to own account.
  • TRAVEL - Travel.
  • WAGES_SALARY - Wages/salary.
Example:

"AUDIO_VISUAL_SERVICES"

source_currency
string
required

The currency that the payer will send out.

Required string length: 3
Example:

"USD"

source_amount
string
required

The amount paid by the payer for the payout.

Example:

"1000.00"

amount_beneficiary_receives
string
required

The amount received by the beneficiary.

Example:

"1000.00"

fee_paid_by
enum<string>
required

The charge type of payment fee. Will only be effective and required when payment_method = SWIFT.

  • SHARED: Transaction fees are split between payer and recipient; payer pays sending bank fees while recipient pays receiving bank fees. Available for SWIFT payouts when the payer is a company and the payer's country is one of the following: SG, VN, HK, or AU.
  • OURS: All transaction fees, including intermediary bank charges, are paid by the payer.
Available options:
SHARED,
OURS
Example:

"SHARED"

fee_currency
string
required

Currency used to pay fees. Three-letter ISO 4217 currency code.

Required string length: 3
Example:

"USD"

fee_amount
string
required

Fee amount of the payout.

Example:

"1.00"

payout_date
string<date>
required

Date of when the system attempt to submit the payment to the beneficiary.

Example:

"2024-03-01"

short_reference_id
string
required

The reference generated by the system to identify the payout.

Example:

"P220406-LLCVLRM"

payout_reference
string
required

Bank payment reference displayed in the beneficiary's bank transaction records. Sent to the recipient (e.g. For Further Credit, For Benefit of, or a custom message). aka Payment reference in Dashboard.

  • SWIFT payments: Must comply with the regex /^[a-zA-Z0-9/-?:().'+, ]+$/.
    Allowed characters: English letters, digits, spaces, and the following special symbols: - / ? : ( ) . ' + ,.
  • LOCAL payments: When payment_method = LOCAL and account_currency_code is not CNH or SGD, no input format validation is applied.
Maximum string length: 100
Example:

"026073150"

payout_reason
string
required

The custom reason for the payout which displayed in the beneficiary's bank transaction records.

Maximum string length: 200
Example:

"Audiovisual services"

payout_status
enum<string>
required

The payout's status.

  • READY_TO_SEND: The payout has been validated and is ready for processing.
  • PENDING: The payout is currently being processed by the system.
  • REJECTED: The payout was rejected due to validation or compliance requirements not being met.
  • FAILED: The payout process encountered an error and could not be completed.
  • COMPLETED: The payout has been successfully processed and funds have been transferred.
Available options:
READY_TO_SEND,
PENDING,
REJECTED,
FAILED,
COMPLETED
create_time
string<date/time>
required

Create time of the payout.

Example:

"2024-03-01T00:00:00+08:00"

update_time
string<date/time>
required

Update time of the payout.

Example:

"2024-03-01T00:00:00+08:00"

complete_time
string<date/time>
required

Completed time of the payout.

Example:

"2024-03-01T00:00:00+08:00"

payout_method
enum<string>
required

The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.

  • LOCAL: Payment processed through domestic payment networks with local clearing systems.
  • SWIFT: International payment processed through the SWIFT network for cross-border transfers.
Available options:
LOCAL,
SWIFT
Example:

"LOCAL"

payer
object
required

Details of the payer associated with this payout.

beneficiary
object
required
failure_returned_amount
string

The amount of the failed payout to be returned.

Example:

"1000.00"

failure_reason
string

The reason why the payout failed.

Example:

""

quote_id
string

ID of the pre-created quote, obtained via Create Quote.

Required only for cross-currency payout scenarios. If provided, payout_currency and payout_amount must also be supplied.

Example:

"784832f7-1f8a-4b08-ac2a-8719b5b2a590"

conversion
object

Details of the currency conversion for the payout. Required only for cross-currency payout scenarios.