Skip to main content
GET
Get a holder by ID

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.

Path Parameters

holderId
string<uuid>
required

Identifier of the resource in Payrails.

Response

Success.

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 9, 2026