Skip to main content
GET
/
balance
/
payouts
cURL
curl --request GET \
  --url https://api.xpaycheckout.com/balance/payouts \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "payoutId": "<string>",
      "amount": 123,
      "status": "INITIATED"
    }
  ],
  "metadata": {
    "offset": "<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

​
startTime
integer

Start of range in epoch milliseconds. Fetches payouts created after this timestamp.

​
endTime
integer

End of range in epoch milliseconds. Fetches payouts created before this timestamp.

​
limit
integer

Max items per page (default 10, max 100)

Required range: 1 <= x <= 100
​
offset
string

Cursor for pagination. Use metadata.offset from previous response

Response

Successful response with payouts and pagination cursor

​
data
object[]
required
​
metadata
object
required
⌘I