Skip to main content

Register Split Beneficiary

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

Register a recipient that order splits can reference by id. The returned id is the beneficiary_id you pass in an order's splits[].

The recipient is identified by IBAN. Whether it is a Paysera account or an external bank account is resolved server-side and returned as destination_type — an external IBAN is only accepted when external beneficiaries are enabled for the project. The IBAN must not resolve to the project owner's own account.

Authorization​

This endpoint requires an OAuth2 Bearer token. The project is taken from the token, so you do not pass a project id. See the Authentication guide.

Request Body​

FieldTypeRequiredDescription
ibanstring✓Recipient's IBAN (Paysera or external)
namestring✓Display name for the beneficiary

Notes​

  • The response's account_number is the resolved Paysera (EVP) account, or the masked IBAN for an external destination (first and last four characters, e.g. DE89***3000 — the full IBAN is never returned).
  • Only EEA SEPA IBANs are accepted; any other IBAN is rejected with 400 invalid_request ("Only EEA SEPA IBANs are accepted").
  • A duplicate account for the project returns 409 conflict.
  • If split beneficiaries aren't enabled, the IBAN belongs to the project owner, the IBAN is external but the project doesn't allow it (external beneficiaries not enabled, no configured split policy, or payer tips enabled — which excludes external beneficiaries), or the Paysera account behind the IBAN is inactive or closed, the API returns 422 unprocessable_entity with the reason in error_description.
  • Tip recipients can also be registered by phone number — see Register split beneficiary by phone.

See Split Payments for the full flow.

AUTHORIZATION: HTTP

REQUEST

Base URL
https://api.paysera.com

RESPONSE

Beneficiary registered
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"destination_type": "paysera_account",
"account_number": "EVP5210018145214",
"name": "Marketplace Seller 42",
"created_at": 1716200000
}