Get Pay Outs List

get

https://openapi.sandbox.xenithpay.com/v1/payouts

You can use this endpoint to retrieve a list of Pay Out requests.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

created_gte

string

Filters Pay Outs created on or after this time, in RFC3339 format (UTC+0).

created_lte

string

Filters Pay Outs created on or before this time, in RFC3339 format (UTC+0).

limit

string

Specifies the maximum number of records to return. The limit can range between 1 and 50.

after_id

string

Returns records after this ID (used for pagination).

before_id

string

Returns records before this ID (used for pagination).

order

string

required

Specifies the sort order of the results, either "asc" or "desc."

currency

string

Filters Pay Outs by currency, using the ISO 4217 three-letter code.

referenceCode

string

Filters Pay Ins by referenceCode provided during creation.

Headers

Content-Type

string

required

Specifies the format of the request body (JSON).

Xenith-Api-Key

string

required

API Key will be delivered to you by email

Xenith-Request-Timestamp

string

required

ISO 8601 date time format, should be in (UTC+0)

Xenith-Request-Signature

string

required

Refer to page Build Signature and Set Headers for instructions on how to build a signature

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

200Successfully get pay out list

400Request failed due to failing request validation. See the Get Pay Out List Errors dictionary for more detail.

500An unexpected server error occurred. Wait briefly and retry. If the error persists after multiple attempts, contact support. Retrying is safe for this GET operation. See the Get Pay Out List Errors dictionary for more detail.