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": 30000,
      "status": "SUCCESS",
      "createdAt": 1727340330123
    }
  ],
  "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<int64>

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

​
endTime
integer<int64>

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

​
limit
integer<int32>

Max items per page (default 10, max 100)

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

Cursor-based pagination token. Use the offset value from metadata.offset in the previous response to fetch the next page. Continue until metadata.offset is no longer present in the response.

🚨 Important: Changing any query parameters invalidates existing offset values and requires restarting pagination from the beginning.

For detailed pagination implementation guide, see Pagination Guide.

Response

Successful response with payouts and pagination cursor.

​
data
object[]
required
​
metadata
object
required