v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB

Cards

Create secure card details token

Create a token that is used as a parameter to retrieve secure card details (PAN, CVV, and PIN) or to perform PIN alterations. This token is to be retrieved by the partner and pushed to the cardholder device where the call is made. The token will be valid for 60 seconds.

post/cards/{cardId}/secure-details-token

Path parameters

cardIdstring required

The ID of the card to generate the token

Headers

X-MOD-CARD-MGMT-TOKENstring

Card Management Token required when the token will be used to alter card details

Request body

publicKeystring

Base64 UTF-8 encoded RSA public key to be used to encrypt the token in the response. The key must be at least 4096 bits in length.

purpose'READ' | 'UPDATE'

What the token will be used for. UPDATE tokens cannot be used for READ purposes, and READ tokens cannot be used for updates.

Response

Card token generated successfully

tokenstring required

The token to use by the client for retrieving card details. Where 'encrypted' is true, this will be a value that must be decrypted on the client device before being used in subsequent API calls

encryptedboolean required

Whether this token is encrypted

encryptedSymmetricKeystring

Base64 UTF-8 encoded Symmetric key used to encrypt token, encrypted with client's public key. Only provided if 'encrypted' is true.

initialisationVectorstring

Base64 UTF-8 encoded initialisation vector used with symmetric key for encrypting the token. Only provided if 'encrypted' is true.

Example response

{
  "token": "eyJ0....zRyk"
}