Skip to main content

Get Token

Use this request to retrieve an existing token

info

HTTP status code 200 indicates success

Endpoint​

Method: GET
/api/tokens/{token}

URI Parameters​

NameDescriptionTypeAdditional Information
tokenToken returned by CreateOrder request when order is finalizedString
required field

Response Information​

NameDescriptionTypeAdditional Information
TokenID of the token, needed to get the tokenGuid
StatusStatus for recurring tokenStatusEnum
CurrencyCurrency as defined by ISO 4217String
PaymentMethodThe payment method associated with the token.
  • Invoice
  • Card
String
PaymentMethodDetailsDetails specific to chosen payment methodCardDetails
Currently null for Invoices

TokenStatus​

Status values indicate in which state the token is:

Status CodeNumerical ValueDescription
Active1Indicates that token is active and available to use for recurring orders.
Cancelled2Indicates that the token is cancelled and no further actions can be made

RecurringCardDetails​

NameDescriptionTypeAdditional Information
ExpiryMonthMonth indicating when the card will expireInt64
ExpiryYearYear indicating when the card will expireInt64