Skip to main content
GET
/
payouts
Get Payouts
curl --request GET \
  --url https://access.utgl.io/v1/payouts \
  --header 'Authorization: Basic <encoded-value>'
{
  "prevPageToken": "<string>",
  "nextPageToken": "<string>",
  "payouts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "xid": "<string>",
      "xmetadata": {
        "key1": "value1",
        "key2": [
          "value2.1",
          "value2.2"
        ]
      },
      "created": "2023-11-07T05:31:56Z",
      "method": "BANK_SWIFT",
      "destination": {
        "type": "BANK_ACCOUNT",
        "accountNumber": 123456,
        "routingNumber": 1234,
        "country": "US",
        "bankName": "Bank of America",
        "bankAddress": "123 Main St, New York, NY 10001, USA",
        "swiftCode": "BOFAUS3N",
        "accountHolderName": "John Doe",
        "accountHolderAddress": "456 Park Ave, New York, NY 10022, USA"
      },
      "accountId": "6a3176fe-7715-4fe0-a548-034912d7f800",
      "sourceCurrency": "<string>",
      "sourceAmount": 123,
      "destinationCurrency": "RMB",
      "destinationAmount": 123,
      "rate": 123,
      "updated": "2023-11-07T05:31:56Z",
      "status": "requested",
      "subStatus": "ORDER_UNDER_AML_REVIEW",
      "cancellationReason": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

pageSize
number

Limits the number returned items Some collections have a upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If no page size is provided, the collection will determine the page size itself.

Required range: x >= 1
pageToken
string
Example:

"aWVHZWV5OVgK"

payoutId
string

Filter by payout id

accountId
string

Filter by account id

xid
string

Filter by xid

Response

200 - application/json

OK

prevPageToken
string

Opaque page token to retrieve next or previous set of results.

nextPageToken
string

Opaque page token to retrieve next or previous set of results.

payouts
object[]