v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

Holders

Create a holder

Create a holder.

post/merchant/holders

x-idempotency-keystring uuid required

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

referencestring required

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

typestring

Value of merchant-defined enumeration of Holder Types.

Created.

idstring uuid required

Unique identifier of the Holder in Payrails.

referencestring required

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

createdAtstring date-time

Date and time when the Holder was created.

statusstring[]

Status of the Holder in Payrails.

typestring

Value of merchant-defined enumeration of Holder Types.