v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
cards

aid_cards_token_post

Get details about a card, including the current balance and available funds. No details will be returned for expired tokens

scopes:

  • admin:wallets
  • write:wallets
  • write:wallets:/info
post/accounts/{aid}/wallets/info

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Request body

tokenstring required

temporary token for a Card

pinstring

PIN for the Card

Response

Card info details

brandstring

Visa, MasterCard, etc. The brand of the card.

masked_panstring
expiry_datestring \d{2}/\d{4}
type'Credit' | 'Debit' | 'Credit Card' | 'Debit Card' | 'Prepaid'
region'domestic' | 'eea' | 'eea-uk' | 'europe' | 'inter'

The region in which the transaction takes place, determined by location of merchant and issuer.

  • domestic: merchant and issuer within the same country.
  • eea: merchant and issuer within EEA, but not the same country.
  • eea-uk: merchant and issuer within EEA plus United Kingdom, but one or both not withing EEA.
  • europe: merchant and issuer within Europe, but one or both not within EEA plus United Kingdom.
  • inter: merchant and/or issuer not within Europe.
countrystring iso-3166-1

The country the card is issued in

product_platform'consumer' | 'commercial'
issuing_bankstring

The name of the bank that issued the card used

acquirer_transaction_type'3DSECURE' | 'SSL'

3DSECURE or SSL. Indicates the transaction type of the acquirer.

acquirer_stanstring

The System Trace Audit Number assigned by the acquirer to uniquely identify the transaction.

acquirer_terminal_idstring

The ID of the acquirer terminal.

acquirer_transaction_timestring date-time

The ISO-8601 date and time of the acquirer transaction.

authentication_status'Y' | 'A' | 'U' | 'N'

Y, A, U or N. Indicates the status of the authentication.

three_ds_versionstring
three_ds_server_trans_idstring
ecistring
payment_system_typestring
payment_tokenstring

The payment token generated by the authorization. Only available for transactions created from session where the generate_payment_token option is enabled in the session configuration, or from payment token sessions where payment_token is included in the token_provider.token_types

  • POST /v1/sessions/payment-token
payment_token_idstring

The id of the payment_token, only included in transaction where a payment_token was generated.

recurrence_tokenstring

The recurrence token generated by the authorization. Only available for transactions created from session where the generate_recurrence_token option is enabled in the session configuration, or from payment token sessions where recurrence_token is included in the token_provider.token_types

  • POST /v1/sessions/payment-token
recurrence_token_idstring

The id of the recurrence_token, only included in transaction where a recurrence_token was generated.

card_holder_tokenization_consent'opt_in' | 'opt_out'

The card holder's consent to tokenization, as provided during authorization. This is only a hint, and the final decision is made by the card issuer.

entry_method'chip' | 'contactless' | 'magstripe'

How the card was read.

Example response

{
  "brand": "Visa",
  "masked_pan": "476173******0416",
  "country": "NOR",
  "three_ds_version": "2",
  "eci": "05",
  "payment_system_type": "wallet"
}