Skip to main content

List Split Beneficiaries

GET https://api.paysera.com/checkout-project/integration/v1/split-beneficiaries

List the project's registered split beneficiaries, cursor-paginated. The merchant's own self-row is included with a null id and cannot be referenced in order splits.

Authorization​

This endpoint requires an OAuth2 Bearer token. The project is taken from the token. See the Authentication guide.

Query Parameters​

ParameterTypeDefaultDescription
afterstring—Cursor for the next page (mutually exclusive with before)
beforestring—Cursor for the previous page (mutually exclusive with after)
order_directionstringdescasc or desc by creation time
include_totalbooleanfalseInclude the total count in _metadata.total
sizeinteger—Page size (1–1000)

Notes​

Each item includes consent_status (given / not_given / null), which gates payer tips on Lithuanian projects. See Split Payments.

AUTHORIZATION: HTTP

REQUEST

Base URL
https://api.paysera.com
Query Parameters
after
Cursor for the next page. Mutually exclusive with `before`.
before
Cursor for the previous page. Mutually exclusive with `after`.
order_direction
Sort direction by creation time.
include_total
Include the total count in `_metadata.total`.
size
Page size.

RESPONSE

Beneficiaries retrieved
{
"items": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"destination_type": "paysera_account",
"account_number": "EVP5210018145214",
"bic": null,
"name": "Marketplace Seller 42",
"created_at": 1716200000,
"consent_status": null
}
],
"_metadata": {
"has_next": false,
"has_previous": false,
"cursors": {
"after": null,
"before": null
},
"total": 1
}
}