> ## Documentation Index > Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt > Use this file to discover all available pages before exploring further. # List Payouts > Retrieves a list of payout transactions. The response can be filtered by specifying a creation date range or payout status. ##### Usage Guidelines: - If `start_time` and `end_time` are both omitted, the API returns payouts from the last 30 days by default. - If only `end_time` is provided, it retrieves payouts within the past 30 days up to `end_time`. ## OpenAPI ````yaml /global-account/v1.6/banking.yaml get /v1/payouts openapi: 3.0.2 info: title: Banking API version: 0.0.1 description: > UQPAY Banking API provides comprehensive banking and payment solutions for global money movement. ## Key Features - International payments and transfers - Multi-currency account management - Real-time currency conversion - Virtual account services - Fund deposit and withdrawal ## Authentication Use API keys to authenticate your client requests when utilizing UQPAY APIs. API keys are unique data strings used to authenticate users and enable access to privileged operations. Your API key should be kept confidential and secure at all times. ## Service Components - **Payout**: Create and manage international fund transfers to beneficiaries - **Payer**: Manage entities making payments and authorizing fund transfers - **Beneficiary**: Handle recipient information and bank details - **Balance**: View and manage multi-currency account balances - **Deposit**: Process incoming fund transfers - **Virtual Accounts**: Utilize local bank accounts in foreign currencies - **Conversion**: Execute currency exchange at competitive rates ## Getting Started 1. Obtain API credentials 2. Set up test environment using sandbox URL 3. Implement authentication 4. Start with basic operations ## Support For technical support and integration assistance, contact UQPAY support team. contact: name: UQPAY Support url: https://www.uqpay.com/support email: banking.tech@uqpay.com license: name: Proprietary url: https://www.uqpay.com/legal/api-terms termsOfService: https://www.uqpay.com/legal/terms x-api-id: banking-api-v1.6.0 x-logo: url: https://uqpay.com/img/UQPAY_LogoAnimv2.gif backgroundColor: '#FFFFFF' altText: UQPAY Logo x-categories: - Banking - Payment Processing - Foreign Exchange servers: - url: https://api-sandbox.uqpaytech.com/api description: Sandbox base URL. - url: https://api.uqpay.com/api description: Production base URL. security: [] tags: - name: Balances description: >- View and manage available funds across different currencies in your account. - name: Transfers description: >- A wallet transfer resource is used for sending funds directly from your UQPAY account to a connected account. - name: Deposits description: >- Deposits are bank transfers made into your UQPAY Global Accounts for adding funds or collecting funds from third parties. - name: Virtual Accounts description: >- Virtual Accounts function as local bank accounts in foreign currencies. They enable worldwide fund collection with account details that allow you to receive funds from various platforms. Virtual Accounts can also be used to top up your UQPAY balance. - name: Payout description: >- A Payout resource is created when you send funds to a beneficiary. It details the beneficiary, bank details, the amount being paid, its status, and other relevant information. You can create the payout using either direct beneficiary details or a previously created beneficiary ID. - name: Payers description: >- The payer is the party making the payout and authorizing the transfer of funds from their account to the beneficiary's account. - name: Beneficiaries description: >- The beneficiary is the recipient of the funds and is typically the party who will ultimately benefit from the payout. - name: Conversion description: Manage currency conversions and exchange rates for your transactions. - name: Exchange Rates description: >- Retrieve real-time exchange rates for a specified currency pair or all available pairs. - name: Global Accounts description: >- ⚠️ WARNING This API version is deprecated. Eventually, a deprecated API version becomes unsupported. Global Accounts are foreign currency accounts that function as local bank accounts. - name: Simulator description: Simulate deposit transactions on the sandbox environment. paths: /v1/payouts: get: tags: - Payouts summary: List Payouts description: > Retrieves a list of payout transactions. The response can be filtered by specifying a creation date range or payout status. ##### Usage Guidelines: - If `start_time` and `end_time` are both omitted, the API returns payouts from the last 30 days by default. - If only `end_time` is provided, it retrieves payouts within the past 30 days up to `end_time`. operationId: list-payouts parameters: - $ref: '#/components/parameters/XOnBehalfOf' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/PayoutStatus' - $ref: '#/components/parameters/StartTime' - $ref: '#/components/parameters/EndTime' responses: '200': description: OK - Successfully retrieved a list of payouts. headers: x-response-id: $ref: '#/components/headers/XResponseId' content: application/json: schema: title: PayoutListResponse properties: total_pages: $ref: '#/components/schemas/TotalPages' total_items: $ref: '#/components/schemas/TotalItems' data: type: array items: $ref: '#/components/schemas/PayoutListResponse' security: - XAuthToken: [] components: parameters: XOnBehalfOf: in: header name: x-on-behalf-of schema: type: string required: false description: > 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](/account-center/v1.6/api-reference/list-connected-accounts-1). If omitted or empty, the request is executed using the master account. More information at [Connected Accounts](/account-center/v1.6/guide/connected-accounts). example: 18523f72-f4de-4f9c-bb8e-ec7d1c4f32be PageSize: name: page_size description: >- The maximum number of items to return per page. Must be between **10 and 100**, inclusive. in: query required: true schema: type: integer minimum: 1 maximum: 100 example: 10 PageNumber: name: page_number description: >- The page number to retrieve a specific set of items. Must be **1 or greater**. in: query required: true schema: type: integer minimum: 1 example: 1 PayoutStatus: name: payout_status description: Status of the payout in: query required: false schema: $ref: '#/components/schemas/PayoutStatus' StartTime: name: start_time description: The start time of `created_time` in ISO8601 format (inclusive). in: query required: false schema: type: string example: '2024-03-01T00:00:00+08:00' EndTime: name: end_time description: The end time of `created_time` in ISO8601 format (inclusive). in: query required: false schema: type: string example: '2024-03-01T00:00:00+08:00' headers: XResponseId: description: >- Universally unique identifier (UUID v4) for the response. Helpful for identifying a request when communicating with UQPAY support. schema: type: string format: uuid example: 2adba88e-9d63-44bc-b975-9b6ae3440dde schemas: TotalPages: type: integer example: 10 description: The total number of pages of available items. TotalItems: type: integer example: 105 description: The total counts of available items. PayoutListResponse: type: object required: - unique_request_id - payout_id - payout_currency - payout_amount - fee_paid_by - fee_currency - fee_amount - payout_date - short_reference_id - payout_reference - payout_reason - payout_status - create_time - update_time - complete_time - purpose_code properties: unique_request_id: $ref: '#/components/schemas/UniqueRequestId' payout_id: $ref: '#/components/schemas/PayoutId' payout_currency: $ref: '#/components/schemas/Currency' payout_amount: $ref: '#/components/schemas/Amount' fee_paid_by: $ref: '#/components/schemas/FeePaidBy' fee_currency: $ref: '#/components/schemas/FeeCurrency' fee_amount: $ref: '#/components/schemas/FeeAmount' payout_date: $ref: '#/components/schemas/PayoutDate' short_reference_id: $ref: '#/components/schemas/PayoutShortReferenceId' payout_reference: $ref: '#/components/schemas/PayoutReference' payout_reason: $ref: '#/components/schemas/PayoutReason' purpose_code: $ref: '#/components/schemas/PurposeCode' payout_status: $ref: '#/components/schemas/PayoutStatus' create_time: $ref: '#/components/schemas/CreateTime' description: Create time of the payout. update_time: $ref: '#/components/schemas/UpdateTime' description: Update time of the payout. complete_time: $ref: '#/components/schemas/CompleteTime' description: Completed time of the payout. failure_returned_amount: $ref: '#/components/schemas/FailureReturnedAmount' failure_reason: $ref: '#/components/schemas/FailureReason' quote_id: $ref: '#/components/schemas/QuoteId' conversion: $ref: '#/components/schemas/PayoutConversion' PayoutStatus: type: string description: > 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. enum: - READY_TO_SEND - PENDING - REJECTED - FAILED - COMPLETED UniqueRequestId: type: string format: uuid example: b3d9d2d5-4c12-4946-a09d-953e82sed2b0 description: >- Universally unique identifier (UUID v4). This identifier will be used by the client in a POST operation to create the resource. PayoutId: type: string format: uuid example: b3d9d2d5-4c12-4946-a09d-953e82sed2b0 description: Unique identifier for the payout. Currency: type: string example: USD description: >- Currency in which money is held in the beneficiary's bank account. Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. maxLength: 3 minLength: 3 Amount: type: string example: '1000.00' description: | The amount that the payer will send out, in `currency`. FeePaidBy: type: string example: SHARED description: > 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. enum: - SHARED - OURS FeeCurrency: type: string example: USD description: >- Currency used to pay fees. Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. maxLength: 3 minLength: 3 FeeAmount: type: string example: '1.00' description: Fee amount of the payout. PayoutDate: type: string format: date example: '2024-03-01' description: >- Date of when the system attempt to submit the payment to the beneficiary. PayoutShortReferenceId: type: string example: P220406-LLCVLRM description: The reference generated by the system to identify the payout. PayoutReference: type: string maxLength: 100 example: '026073150' description: > 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. PayoutReason: type: string maxLength: 200 example: Audiovisual services description: >- The custom reason for the payout which displayed in the beneficiary's bank transaction records. PurposeCode: type: string example: AUDIO_VISUAL_SERVICES description: | 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. CreateTime: type: string format: date/time example: '2024-03-01T00:00:00+08:00' description: >- The timestamp when the record was created in the system. Timestamp follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. UpdateTime: type: string format: date/time example: '2024-03-01T00:00:00+08:00' CompleteTime: type: string format: date/time example: '2024-03-01T00:00:00+08:00' description: >- The timestamp when the request was successfully processed and marked as `COMPLETED`. FailureReturnedAmount: type: string example: '1000.00' description: The amount of the failed payout to be returned. FailureReason: type: string example: '' description: The reason why the payout failed. QuoteId: type: string example: 784832f7-1f8a-4b08-ac2a-8719b5b2a590 description: > ID of the pre-created quote, obtained via [Create Quote](/global-account/v1.6/api-reference/create-quote). Required only for cross-currency payout scenarios. If provided, `payout_currency` and `payout_amount` must also be supplied. PayoutConversion: type: object description: | Details of the currency conversion for the payout. Required only for cross-currency payout scenarios. properties: currency_pair: type: string description: The currency pair that the rate is for. example: USDEUR client_rate: type: string description: The exchange rate applied to the transaction. example: '1.355957' securitySchemes: XAuthToken: type: apiKey in: header name: x-auth-token description: The API token for login provided by UQPay. ````