Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
InstrumentTokens

Get a token by reference

Get a token by its reference.

get/payment/providers/{providerId}/tokens/{tokenReference}

Path parameters

providerIdstring uuid required

Identifier of the resource in Payrails.

tokenReferencestring required

Path parameter with the reference to the token in the provider.

Response

Success.

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.

instrumentIdstring uuid required

Id of the payment instrument the token belongs to.

status'created' | 'enabled' | 'disabled' | 'deleted' required

Status of the token.

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

Type of the token.

providerIdstring uuid required

Id of the provider the token belongs to.

providerConfigIdstring uuid

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

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.