Skip to main content
POST
Create a holder

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Headers

x-idempotency-key
string<uuid>
required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Body

application/json
reference
string
required

Merchant-specific reference for the Holder. Usually mapped to the user ID in the merchant's system.

type
string

Value of merchant-defined enumeration of Holder Types.

Response

Created.

id
string<uuid>
required

Unique identifier of the Holder in Payrails.

reference
string
required

Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.

createdAt
string<date-time>

Date and time when the Holder was created.

status
string[]

Status of the Holder in Payrails.

type
string

Value of merchant-defined enumeration of Holder Types.

Last modified on October 7, 2026