v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

InstrumentTokens

Create a token

Create a token for a payment instrument.

post/payment/instruments/{instrumentId}/tokens

instrumentIdstring uuid required

Identifier of the resource in Payrails.

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.

providerIdstring uuid required

Id of the provider the token belongs to.

providerConfigIdstring uuid

Id of the configuration in the provider the token belongs to.

type'network' | 'vault' | 'psp' | 'networkOffers' | 'networkGateway' required

Type of the token.

referencestring required

Unique identifier of the token in the provider's system.

metaobject

Any merchant or provider-specific data that should be stored for context in the token, e.g. holderReference is required for Adyen tokens.

Created.

idstring uuid required

Id of the token in Payrails.

createdAtstring date-time required

Date and time when the Token was created in Payrails.

updatedAtstring date-time required

When the Token was last updated.