Skip to main content
POST
Retrieve Card Data | Additional Method

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-audit-user
string

Optional audit user header

Path Parameters

id
string<uuid>
required

Unique identifier of the card whose details you want to retrieve.

Body

application/json
encryptionKey
string
required

Public key used to encrypt the fields in the result.

Minimum string length: 1
Example:

"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB"

encryptionMethod
enum<string>
required

In this field the encryption method is selected. This is to prepared for future use since only one method is now supported.

Available options:
RSA_ECB_OAEP_SHA256_MGF1_2048
Example:

"RSA_ECB_OAEP_SHA256_MGF1_2048"

fields
enum<string>[]
required

In this field you can include the parameters that you want to be returned in an encrypted way. If a field is not listed, it will be left out from the response. Note that only primaryAccountNumber and CVV2 will be encrypted.

Minimum array length: 1
Available options:
PRIMARY_ACCOUNT_NUMBER,
EXPIRATION_DATE,
CVV2
sequenceNumber
integer

The sequence number of the card version to use. If not specified, the latest card version is used by default.

Required range: x >= 1
Example:

1

Response

Successful retrieval of the card data.

primaryAccountNumber
string
required

The encrypted full card number (PAN) — Base64 encoded.

Example:

"Z5zt5TbIc2jZ/iCnleh7pBIxxf/M046X7t7zhl/YPVl5wep3HulMqYKE3mgjqo/H+dUVlk6PcgvcQR4Gb/tYG6UVZhR+S9xfswEXB8RwLdqBc5mlCZNkCxlTeyqWfQcmknXdQY25+Yeg/z9DVEmNqxzhAOfx5KYsILdc8k9svMj+UWU64SDKbIqTVuP0D/UMbJEixLknRtyXu1j80ZOJCKGvW+aBwrEiOTp07teKcFu43ND5m083e9OqFE7qcnFAj7CNeIRRP9rDOK+qvEvs+h28yAytG2NS5Qwt9gulpaE9gz+ClS3wCVG9uPRyrrKtVGRrgDfDaf6AngVPmJ3EeA=="

expirationDate
string
required

The expiration date of the card in MMYY format.

Example:

"1227"

cvv2
string
required

The encrypted CVV2 (for Visa) or CVC2 (for Mastercard) value — Base64 encoded.

Example:

"PitrZmfUd6blAk8SLZFkCBXql+UKrR+Q79VImTrZfZu24zwGjYQML2h563HYM8KvoqdNIk2gQ6jSYt81d/0I/1ZoDmTcJsduoGmHSwATuQh2c926O/SMa4cbnR8JQHZ7FaExgsc2dZ/ZjYcf1Ehsg0r4CDcZ6MUYBrCUTlaPbTksjxQhj3fqovBBN1smfR4No5BHTyPvJmeUPQiqtlrLzBvQj+PxYRukrkxGkgZ+HmRg+zWNbS6sWmurvR0gb1l1GRPGG132L6oFcqpjZxZYTsq5yf0hEDXZdWo6oYc3JJ2s7SVxVNwoMvQQi7YV+iZD7wyPXgeHFFXZGhKyYY3F7w=="