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​
| Parameter | Type | Default | Description |
|---|---|---|---|
after | string | — | Cursor for the next page (mutually exclusive with before) |
before | string | — | Cursor for the previous page (mutually exclusive with after) |
order_direction | string | desc | asc or desc by creation time |
include_total | boolean | false | Include the total count in _metadata.total |
size | integer | — | 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
afterCursor for the next page. Mutually exclusive with `before`.
beforeCursor for the previous page. Mutually exclusive with `after`.
order_directionSort direction by creation time.
include_totalInclude the total count in `_metadata.total`.
sizePage 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
}
}