API Reference

Server API version 1.0
Java

Results for

icon-search-large No search results yet
Enter your search query above

Get token

GET https://{domainname}/v1/{merchantId}/tokens/{tokenId}

Tokens

Using our tokenization service you can tokenize re-usable payment data like card data, bank account data including Direct Debit Mandates and PayPal BillingAgreementIDs. The main purpose for tokens is re-use of payment details. The additional benefit is that you do not need to store any sensitive payment details on your server, while still having the benefit to be able to re-use them. This allows you to process recurring card transactions without actually having access to the real card data.

Tokens can be used for two types of transactions:

  • Recurring: Automatically charging your consumer in a regular, e.g. monthly, time frame;
  • One-off: Charge the consumer without the consumer having to re-enter all of their payment details.

The second scenario can be used to facilitate a one-click checkout solution, that would still allow the consumer to enter only their CVV value for a card transaction. CVV values can't be tokenized as they are not allowed to be stored at all.

Besides the re-use of payment data, tokens have one other major use-case: Direct Debit Mandates. Especially SEPA Direct Debit transactions require that the mandate for the transactions is managed through a token with an associated mandate. Mandates are created in one go with the token, but can have a state that requires that they are approved before they can be used. As the mandate process is in most cases an offline process the approval will allow you to set the location and date where and when the mandate was signed by the consumer. Without an approved SEPA mandate you will not be able to process any payments regarding this mandate.

Request

Use GET on a specific token to retrieve all the tokenized data for that ID. You can use some of this data towards the consumer to let them choose which stored data to re-use. You can also use data like the expiry date to check if you need to ask for updated data from your consumer.

We will never return full card details.
The request does not have any additional input parameters.

Request example

SDK: Java

This scenario you will probably use the most

  • TokenResponse response = client.merchant("merchantId").tokens().get("tokenId");
    

Responses

Please find below an overview of the possible responses.

Response 200 - OKTokenResponse

All non-sensitive data that is stored is returned.

Property Type Required Details
Group card object no, one of group read close
close

Description

Object containing card details
  • SDK Object type
    TokenCard
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

alias string (100) no read close
close

Description

An alias for the token. This can be used to visually represent the token.
If no alias is given in Create token calls, a payment product specific default is used, e.g. the obfuscated card number for card payment products.
Do not include any unobfuscated sensitive data in the alias.
customer object yes read close
close

Description

Object containing the details of the consumer
  • SDK Object type
    CustomerToken
billingAddress object yes read close
close

Description

Object containing the billing address details
  • SDK Object type
    Address
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.
houseNumber string (15) depends read close
close

Description

House number

Depends on:

Required when address is included in Seller.
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
Note: For payments with product 1503 the maximum length is not 9 but 2.
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
zip string (10) depends read close
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.
companyInformation object no read close
close

Description

Object containing company information
  • SDK Object type
    CompanyInformation
name string (40) no read close
close

Description

Name of company, as a consumer
merchantCustomerId string (15) no read close
close

Description

Your identifier for the consumer that can be used as a search criteria in the Global Collect Payment Console and is also included in the Global Collect report files. For Ingenco's Ogone Payment Platform this field is used in the fraud-screening process.
personalInformation object no read close
close

Description

Object containing personal information of the consumer
  • SDK Object type
    PersonalInformationToken
name object no read close
close

Description

Given name(s) or first name(s) of the consumer
  • SDK Object type
    PersonalNameToken
firstName string (15) no read close
close

Description

Given name(s) or first name(s) of the consumer
surname string (70) no read close
close

Description

Surname(s) or last name(s) of the consumer
surnamePrefix string (15) no read close
close

Description

Middle name - In between first name and surname - of the consumer
vatNumber string (17) no read close
close

Description

Local VAT number of the consumer
data object yes read close
close

Description

Object containing the card tokenizable details
  • SDK Object type
    TokenCardData
cardWithoutCvv object yes read close
close

Description

Object containing the card details (without CVV)
  • SDK Object type
    CardWithoutCvv
cardNumber string (19) depends read close
close

Description

The complete credit/debit card number (also know as the PAN)

Depends on:

Required for Create and Update token.
cardholderName string (51) no read close
close

Description

Card holder's name on the card
expiryDate string (4) depends read close
close

Description

Expiry date of the card
Format: MMYY

Depends on:

Required for Create and Update token.
issueNumber string (2) no read close
close

Description

Issue number on the card (if applicable)
firstTransactionDate string (8) no read close
close

Description

Date of the first transaction (for ATOS)
Format: YYYYMMDD
providerReference string (4000) no read close
close

Description

Reference of the provider (of the first transaction) - used to store the ATOS Transaction Certificate
Group eWallet object no, one of group read close
close

Description

Object containing eWallet details
  • SDK Object type
    TokenEWallet
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

alias string (100) no read close
close

Description

An alias for the token. This can be used to visually represent the token.
If no alias is given in Create token calls, a payment product specific default is used, e.g. the obfuscated card number for card payment products.
Do not include any unobfuscated sensitive data in the alias.
customer object yes read close
close

Description

Object containing the details of the consumer
  • SDK Object type
    CustomerToken
billingAddress object yes read close
close

Description

Object containing the billing address details
  • SDK Object type
    Address
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.
houseNumber string (15) depends read close
close

Description

House number

Depends on:

Required when address is included in Seller.
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
Note: For payments with product 1503 the maximum length is not 9 but 2.
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
zip string (10) depends read close
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.
companyInformation object no read close
close

Description

Object containing company information
  • SDK Object type
    CompanyInformation
name string (40) no read close
close

Description

Name of company, as a consumer
merchantCustomerId string (15) no read close
close

Description

Your identifier for the consumer that can be used as a search criteria in the Global Collect Payment Console and is also included in the Global Collect report files. For Ingenco's Ogone Payment Platform this field is used in the fraud-screening process.
personalInformation object no read close
close

Description

Object containing personal information of the consumer
  • SDK Object type
    PersonalInformationToken
name object no read close
close

Description

Given name(s) or first name(s) of the consumer
  • SDK Object type
    PersonalNameToken
firstName string (15) no read close
close

Description

Given name(s) or first name(s) of the consumer
surname string (70) no read close
close

Description

Surname(s) or last name(s) of the consumer
surnamePrefix string (15) no read close
close

Description

Middle name - In between first name and surname - of the consumer
vatNumber string (17) no read close
close

Description

Local VAT number of the consumer
data object yes read close
close

Description

Object containing the eWallet tokenizable data
  • SDK Object type
    TokenEWalletData
billingAgreementId string (50) depends read close
close

Description

Identification of the PayPal recurring billing agreement

Depends on:

Required for the creation of a PayPal token.
Group nonSepaDirectDebit object no, one of group read close
close

Description

Object containing the non SEPA Direct Debit details
  • SDK Object type
    TokenNonSepaDirectDebit
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

alias string (100) no read close
close

Description

An alias for the token. This can be used to visually represent the token.
If no alias is given in Create token calls, a payment product specific default is used, e.g. the obfuscated card number for card payment products.
Do not include any unobfuscated sensitive data in the alias.
customer object yes read close
close

Description

Object containing the details of the consumer
  • SDK Object type
    CustomerToken
billingAddress object yes read close
close

Description

Object containing the billing address details
  • SDK Object type
    Address
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.
houseNumber string (15) depends read close
close

Description

House number

Depends on:

Required when address is included in Seller.
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
Note: For payments with product 1503 the maximum length is not 9 but 2.
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
zip string (10) depends read close
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.
companyInformation object no read close
close

Description

Object containing company information
  • SDK Object type
    CompanyInformation
name string (40) no read close
close

Description

Name of company, as a consumer
merchantCustomerId string (15) no read close
close

Description

Your identifier for the consumer that can be used as a search criteria in the Global Collect Payment Console and is also included in the Global Collect report files. For Ingenco's Ogone Payment Platform this field is used in the fraud-screening process.
personalInformation object no read close
close

Description

Object containing personal information of the consumer
  • SDK Object type
    PersonalInformationToken
name object no read close
close

Description

Given name(s) or first name(s) of the consumer
  • SDK Object type
    PersonalNameToken
firstName string (15) no read close
close

Description

Given name(s) or first name(s) of the consumer
surname string (70) no read close
close

Description

Surname(s) or last name(s) of the consumer
surnamePrefix string (15) no read close
close

Description

Middle name - In between first name and surname - of the consumer
vatNumber string (17) no read close
close

Description

Local VAT number of the consumer
mandate object yes read close
close

Description

Object containing the mandate details
  • SDK Object type
    MandateNonSepaDirectDebit
Group paymentProduct705SpecificData object yes, one of group read close
close

Description

Object containing specific data for Direct Debit UK
  • SDK Object type
    TokenNonSepaDirectDebitPaymentProduct705SpecificData
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

authorisationId string (18) depends read close
close

Description

Core reference number for the direct debit instruction in UK

Depends on:

Required except when a token has been included in the request that includes this value.
bankAccountBban object yes read close
close

Description

Object containing account holder name and bank account information
  • SDK Object type
    BankAccountBban
accountHolderName string (30) depends read close
close

Description

Name of the account holder

Depends on:

Required for Create and Update token calls for ACH (730).
accountNumber string (30) depends read close
close

Description

Bank account number

Depends on:

Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value.
Required for Create and Update token calls.
bankCode string (15) depends read close
close

Description

Bank code

Depends on:

Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value.
Required for Create and Update token calls for ACH (730).
bankName string (40) no read close
close

Description

Name of the bank
branchCode string (15) no read close
close

Description

Branch code
checkDigit string (2) no read close
close

Description

Bank check digit
countryCode string (2) no read close
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
Group paymentProduct730SpecificData object yes, one of group read close
close

Description

Object containing specific data for ACH
  • SDK Object type
    TokenNonSepaDirectDebitPaymentProduct730SpecificData
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

bankAccountBban object yes read close
close

Description

Object containing account holder name and bank account information
  • SDK Object type
    BankAccountBban
accountHolderName string (30) depends read close
close

Description

Name of the account holder

Depends on:

Required for Create and Update token calls for ACH (730).
accountNumber string (30) depends read close
close

Description

Bank account number

Depends on:

Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value.
Required for Create and Update token calls.
bankCode string (15) depends read close
close

Description

Bank code

Depends on:

Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value.
Required for Create and Update token calls for ACH (730).
bankName string (40) no read close
close

Description

Name of the bank
branchCode string (15) no read close
close

Description

Branch code
checkDigit string (2) no read close
close

Description

Bank check digit
countryCode string (2) no read close
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
Group sepaDirectDebit object no, one of group read close
close

Description

Object containing the SEPA Direct Debit details
  • SDK Object type
    TokenSepaDirectDebit
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

alias string (100) no read close
close

Description

An alias for the token. This can be used to visually represent the token.
If no alias is given in Create token calls, a payment product specific default is used, e.g. the obfuscated card number for card payment products.
Do not include any unobfuscated sensitive data in the alias.
customer object yes read close
close

Description

Object containing the details of the consumer
  • SDK Object type
    CustomerTokenWithContactDetails
billingAddress object depends read close
close

Description

Object containing the billing address details

Depends on:

Required for the creation of a token for the countryCode field within this object.
  • SDK Object type
    Address
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.
houseNumber string (15) depends read close
close

Description

House number

Depends on:

Required when address is included in Seller.
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
Note: For payments with product 1503 the maximum length is not 9 but 2.
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
zip string (10) depends read close
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.
companyInformation object no read close
close

Description

Object containing company information
  • SDK Object type
    CompanyInformation
name string (40) no read close
close

Description

Name of company, as a consumer
contactDetails object no read close
close

Description

Object containing contact details like email address and phone number
  • SDK Object type
    ContactDetailsToken
emailAddress string (70) no read close
close

Description

Email address of the consumer
emailMessageType string no read close
close

Description

Preference for the type of email message markup
  • plain-text
  • html
merchantCustomerId string (15) no read close
close

Description

Your identifier for the consumer that can be used as a search criteria in the Global Collect Payment Console and is also included in the Global Collect report files. For Ingenco's Ogone Payment Platform this field is used in the fraud-screening process.
personalInformation object no read close
close

Description

Object containing personal information of the consumer
  • SDK Object type
    PersonalInformationToken
name object no read close
close

Description

Given name(s) or first name(s) of the consumer
  • SDK Object type
    PersonalNameToken
firstName string (15) no read close
close

Description

Given name(s) or first name(s) of the consumer
surname string (70) no read close
close

Description

Surname(s) or last name(s) of the consumer
surnamePrefix string (15) no read close
close

Description

Middle name - In between first name and surname - of the consumer
vatNumber string (17) no read close
close

Description

Local VAT number of the consumer
mandate object yes read close
close

Description

Object containing the mandate details
  • SDK Object type
    MandateSepaDirectDebit
bankAccountIban object depends read close
close

Description

Object containing Account holder and IBAN information

Depends on:

Required for the creation of a token for the iban field within this object.
  • SDK Object type
    BankAccountIban
accountHolderName string (30) depends read close
close

Description

Name in which the account is held.

Depends on:

Required for the creation of a Payout
Required for Create and Update token calls.
iban string (50) depends read close
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.

Depends on:

Required for the creation of a Payout
Required for Create and Update token.
Required for payments with product 9000 in Austria (AT) and Germany (DE).
Required for Create mandate and Create payment with mandate calls
creditor object no read close
close

Description

Object containing information on the creditor
  • SDK Object type
    Creditor
additionalAddressInfo string no read close
close

Description

Additional information about the creditor's address, like Suite II, Apartment 2a
city string no read close
close

Description

City of the creditor address
countryCode string no read close
close

Description

ISO 3166-1 alpha-2 country code
houseNumber string no read close
close

Description

House number of the creditor address
iban string no read close
close

Description

Creditor IBAN number
The IBAN is the International Bank Account Number. It is an internationally agreed format for the bank account number and includes the ISO country code and two check digits.
id string no read close
close

Description

Creditor identifier
name string no read close
close

Description

Name of the collecting creditor
referenceParty string no read close
close

Description

Creditor type of the legal reference of the collecting entity
referencePartyId string no read close
close

Description

Legal reference of the collecting creditor
street string no read close
close

Description

Street of the creditor address
zip string no read close
close

Description

ZIP code of the creditor address
customerContractIdentifier string (35) no read close
close

Description

Identifies the contract between consumer and merchant
debtor object depends read close
close

Description

Object containing information on the debtor

Depends on:

Required for the creation of a token for the surname field within this object.
  • SDK Object type
    Debtor
additionalAddressInfo string (50) no read close
close

Description

Additional information about the debtor's address, like Suite II, Apartment 2a
city string (51) no read close
close

Description

City of the debtor's address
countryCode string (2) no read close
close

Description

ISO 3166-1 alpha-2 country code of the debtor's address
firstName string (15) no read close
close

Description

Debtor first name
houseNumber string (15) no read close
close

Description

House number of the debtor's address
state string (35) no read close
close

Description

State of debtor address
stateCode string (9) no read close
close

Description

State Code of the debtor's address
street string (50) no read close
close

Description

Street of debtor's address
surname string (70) depends read close
close

Description

Debtor's last name

Depends on:

Required for the creation of a token.
surnamePrefix string (15) no read close
close

Description

Prefix of the debtor's last name
zip string (10) no read close
close

Description

ZIP code of the debtor's address
isRecurring boolean no read close
close

Description

  • true
  • false
mandateApproval object no read close
close

Description

Object containing the details of the mandate approval
  • SDK Object type
    MandateApproval
mandateSignatureDate string (8) no read close
close

Description

The date when the mandate was signed
Format: YYYYMMDD
mandateSignaturePlace string (51) no read close
close

Description

The city where the mandate was signed
mandateSigned boolean no read close
close

Description

  • true = Mandate is signed
  • false = Mandate is not signed
mandateId string no read close
close

Description

Unique mandate identifier
preNotification string no read close
close

Description

Indicates whether a pre-notification should be sent to the consumer.
  • do-not-send - Do not send a pre-notification
  • send-on-first-collection - Send a pre-notification
id string yes read close
close

Description

ID of the token
paymentProductId integer yes read close
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "id" : "9511cb6c-a9b1-4d16-a576-dca13f72add3",
        "paymentProductId" : 770,
        "sepaDirectDebit" : {
            "customer" : {
                "companyInformation" : {
                    "name" : "Acme Labs"
                },
                "merchantCustomerId" : "1234",
                "billingAddress" : {
                    "additionalInfo" : "Suite II",
                    "city" : "Monument Valley",
                    "countryCode" : "US",
                    "houseNumber" : "1",
                    "state" : "Utah",
                    "street" : "Desertroad",
                    "zip" : "84536"
                },
                "personalInformation" : {
                    "name" : {
                        "firstName" : "Wile",
                        "surname" : "Coyote",
                        "surnamePrefix" : "E."
                    }
                },
                "contactDetails" : {
                    "emailAddress" : "wile.e.coyote@acmelabs.com",
                    "emailMessageType" : "html"
                }
            },
            "mandate" : {
                "bankAccountIban" : {
                    "accountHolderName" : "Wile E. Coyote",
                    "iban" : "IT60X0542811101000000123456"
                },
                "customerContractIdentifier" : "123456789",
                "debtor" : {
                    "city" : "Burbank",
                    "countryCode" : "US",
                    "firstName" : "Chuck",
                    "houseNumber" : "411",
                    "state" : "California",
                    "stateCode" : "CA",
                    "street" : "N Hollywood Way",
                    "surname" : "Jones",
                    "zip" : "91505"
                },
                "mandateApproval" : {
                    "mandateSignatureDate" : "20150102",
                    "mandateSignaturePlace" : "Monument Valley",
                    "mandateSigned" : true
                },
                "mandateId" : "G9991L0X14981",
                "preNotification" : "do-not-send",
                "isRecurring" : true,
                "creditor" : {
                    "city" : "Monument Valley",
                    "countryCode" : "US",
                    "houseNumber" : "13",
                    "id" : "US123456",
                    "name" : "Road Runner",
                    "street" : "Desertroad",
                    "zip" : "84536"
                }
            }
        }
    }
    

Response 400 - Bad requestErrorResponse

Property Type Required Details
errorId string yes read close
close

Description

Unique reference, for debugging purposes, of this error response
errors array of object yes read close
close

Description

List of one or more errors
items object no read close
close
  • SDK Object type
    APIError
category string no read close
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code string yes read close
close

Description

Error code
httpStatusCode integer no read close
close

Description

HTTP status code for this error that can be used to determine the type of error
id string no read close
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
message string no read close
close

Description

Human-readable error message that is not meant to be relayed to consumer as it might tip off people who are trying to commit fraud
propertyName string no read close
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId string no read close
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
        "errors" : [
            {
                "code" : "20000000",
                "propertyName" : "bankAccountBban.accountNumber",
                "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
            }
        ]
    }
    

Response 404 - Not foundErrorResponse

In case you are trying to retrieve a token that does not exist or has been deleted you will get a 404 response.

Property Type Required Details
errorId string yes read close
close

Description

Unique reference, for debugging purposes, of this error response
errors array of object yes read close
close

Description

List of one or more errors
items object no read close
close
  • SDK Object type
    APIError
category string no read close
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code string yes read close
close

Description

Error code
httpStatusCode integer no read close
close

Description

HTTP status code for this error that can be used to determine the type of error
id string no read close
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
message string no read close
close

Description

Human-readable error message that is not meant to be relayed to consumer as it might tip off people who are trying to commit fraud
propertyName string no read close
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId string no read close
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "errorId" : "657b10da-d2f9-4088-a948-bf190ef516b1-00000318",
        "errors" : [
            {
                "code" : "700540",
                "message" : "PROFILE_NOT_FOUND"
            }
        ]
    }
    
icon_top_1