Create token
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 this call to tokenize payment details. Note that only basic input validation is performed as no actual transaction is processed. We do not check the validity of the payment details with any of its acquirers or third party payment processors. If you want to only tokenize payment details that have been successfully processed it is advised to create tokens using the tokenize action on successful payments. The payload can, next to the paymentProductID contain one of the following types of objects to tokenize:
- card data
- SEPA Direct Debit data (including mandate information)
- Non SEPA Direct Debit data
- eWallet data
Tokenization using Encrypted Customer Input
Note: this applies only for sending encrypted customer card data, and cannot be used to tokenize (SEPA) Direct Debit or eWallet data
The mandatory and optional fields are the same as for the card group when not using the encrypted customer input.
Please ensure that the following 3 mandatory fields are present:- cardNumber
- expiryDate
- countryCode
- cardholderName
- additionalInfo
- city
- houseNumber
- stateCode
- street
- zip
- firstName
- surname
PayloadCreateTokenRequest
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
object | no | read close | |
close
DescriptionObject containing card details
|
|||
alias | string (100) | no | read close |
close
DescriptionAn 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. |
|||
object | depends | read close | |
object | no | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | depends | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
name | string (40) | depends depends no no no | read close |
close
DescriptionName of company, as a customer
|
|||
vatNumber | string (17) | depends | read close |
close
DescriptionLocal VAT number of the company
|
|||
merchantCustomerId | string (15) | no | read close |
close
DescriptionYour identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
|
|||
object | no | read close | |
close
DescriptionObject containing personal information of the customer
|
|||
object | no | read close | |
firstName | string (15) | no | read close |
close
DescriptionGiven name(s) or first name(s) of the customer
|
|||
surname | string (70) | no | read close |
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionMiddle name - In between first name and surname - of the customer
|
|||
vatNumber | string (17) | no | read close |
close
Deprecated:
Use companyInformation.vatNumber instead
DescriptionLocal VAT number of the company
|
|||
object | yes | read close | |
object | yes | read close | |
cardNumber | string (19) | depends | read close |
close
DescriptionThe complete credit/debit card number (also know as the PAN). The minimum input length is 12 digits.
|
|||
cardholderName | string | no | read close |
close
DescriptionCard holder's name on the card
|
|||
expiryDate | string (4) | depends | read close |
close
DescriptionExpiry date of the card
Format: MMYY |
|||
issueNumber | string (2) | no | read close |
close
DescriptionIssue number on the card (if applicable)
|
|||
firstTransactionDate | string (8) | no | read close |
close
DescriptionDate of the first transaction (for ATOS)
Format: YYYYMMDD |
|||
providerReference | string (4000) | no | read close |
close
DescriptionReference of the provider (of the first transaction) - used to store the ATOS Transaction Certificate
|
|||
object | no | read close | |
close
DescriptionObject containing eWallet details
|
|||
alias | string (100) | no | read close |
close
DescriptionAn 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. |
|||
object | yes | read close | |
object | no | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes no | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
name | string (40) | depends depends no no no | read close |
close
DescriptionName of company, as a customer
|
|||
vatNumber | string (17) | depends | read close |
close
DescriptionLocal VAT number of the company
|
|||
merchantCustomerId | string (15) | no | read close |
close
DescriptionYour identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
|
|||
object | no | read close | |
close
DescriptionObject containing personal information of the customer
|
|||
object | no | read close | |
firstName | string (15) | no | read close |
close
DescriptionGiven name(s) or first name(s) of the customer
|
|||
surname | string (70) | no | read close |
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionMiddle name - In between first name and surname - of the customer
|
|||
vatNumber | string (17) | no | read close |
close
Deprecated:
Use companyInformation.vatNumber instead
DescriptionLocal VAT number of the company
|
|||
object | yes | read close | |
billingAgreementId | string (50) | depends | read close |
close
DescriptionIdentification of the PayPal recurring billing agreement
|
|||
object | no | read close | |
close
DescriptionObject containing non SEPA Direct Debit details
|
|||
alias | string (100) | no | read close |
close
DescriptionAn 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. |
|||
object | yes | read close | |
object | no | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes no | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
name | string (40) | depends depends no no no | read close |
close
DescriptionName of company, as a customer
|
|||
vatNumber | string (17) | depends | read close |
close
DescriptionLocal VAT number of the company
|
|||
merchantCustomerId | string (15) | no | read close |
close
DescriptionYour identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
|
|||
object | no | read close | |
close
DescriptionObject containing personal information of the customer
|
|||
object | no | read close | |
firstName | string (15) | no | read close |
close
DescriptionGiven name(s) or first name(s) of the customer
|
|||
surname | string (70) | no | read close |
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionMiddle name - In between first name and surname - of the customer
|
|||
vatNumber | string (17) | no | read close |
close
Deprecated:
Use companyInformation.vatNumber instead
DescriptionLocal VAT number of the company
|
|||
object | yes | read close | |
object | one of the group | read close | |
close
DescriptionObject containing specific data for Direct Debit UK
|
|||
authorisationId | string (18) | depends | read close |
close
DescriptionCore reference number for the direct debit instruction in UK
|
|||
object | yes | read close | |
close
DescriptionObject containing account holder name and bank account information
|
|||
accountHolderName | string (30) | depends | read close |
close
DescriptionName of the account holder
|
|||
accountNumber | string | depends | read close |
close
DescriptionBank account number
|
|||
bankCode | string | depends | read close |
close
DescriptionBank code
|
|||
bankName | string (40) | no | read close |
close
DescriptionName of the bank
|
|||
branchCode | string | no | read close |
close
DescriptionBranch code
|
|||
checkDigit | string | no | read close |
close
DescriptionBank check digit
|
|||
countryCode | string (2) | no | read close |
close
DescriptionISO 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.
|
|||
object | one of the group | read close | |
close
DescriptionObject containing specific data for ACH
|
|||
object | yes | read close | |
close
DescriptionObject containing account holder name and bank account information
|
|||
accountHolderName | string (30) | depends | read close |
close
DescriptionName of the account holder
|
|||
accountNumber | string | depends | read close |
close
DescriptionBank account number
|
|||
bankCode | string | depends | read close |
close
DescriptionBank code
|
|||
bankName | string (40) | no | read close |
close
DescriptionName of the bank
|
|||
branchCode | string | no | read close |
close
DescriptionBranch code
|
|||
checkDigit | string | no | read close |
close
DescriptionBank check digit
|
|||
countryCode | string (2) | no | read close |
close
DescriptionISO 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.
|
|||
object | no | read close | |
close
DescriptionObject containing SEPA Direct Debit details
|
|||
alias | string (100) | no | read close |
close
DescriptionAn 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. |
|||
object | yes | read close | |
close
DescriptionObject containing the details of the customer
|
|||
object | depends | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes no | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
name | string (40) | depends depends no no no | read close |
close
DescriptionName of company, as a customer
|
|||
vatNumber | string (17) | depends | read close |
close
DescriptionLocal VAT number of the company
|
|||
object | no | read close | |
close
DescriptionObject containing contact details like email address and phone number
|
|||
emailAddress | string (70) | no | read close |
close
DescriptionEmail address of the customer
|
|||
emailMessageType | string | no | read close |
close
DescriptionPreference for the type of email message markup
|
|||
merchantCustomerId | string (15) | no | read close |
close
DescriptionYour identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
|
|||
object | no | read close | |
close
DescriptionObject containing personal information of the customer
|
|||
object | no | read close | |
firstName | string (15) | no | read close |
close
DescriptionGiven name(s) or first name(s) of the customer
|
|||
surname | string (70) | no | read close |
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionMiddle name - In between first name and surname - of the customer
|
|||
vatNumber | string (17) | no | read close |
close
Deprecated:
Use companyInformation.vatNumber instead
DescriptionLocal VAT number of the company
|
|||
object | yes | read close | |
close
DescriptionObject containing the mandate details
|
|||
object | depends | read close | |
close
DescriptionObject containing Account holder and IBAN information
|
|||
accountHolderName | string (30) | depends | read close |
close
DescriptionName in which the account is held.
|
|||
iban | string (50) | depends | read close |
close
DescriptionThe 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.
|
|||
customerContractIdentifier | string (35) | no | read close |
close
DescriptionIdentifies the contract between customer and merchant
|
|||
object | depends | read close | |
additionalAddressInfo | string (50) | no | read close |
close
DescriptionAdditional information about the debtor's address, like Suite II, Apartment 2a
|
|||
city | string (51) | no | read close |
close
DescriptionCity of the debtor's address
|
|||
countryCode | string (2) | no | read close |
close
DescriptionISO 3166-1 alpha-2 country code of the debtor's address
|
|||
firstName | string (15) | no | read close |
close
DescriptionDebtor first name
|
|||
houseNumber | string (15) | no | read close |
close
DescriptionHouse number of the debtor's address
|
|||
state | string (35) | no | read close |
close
DescriptionState of debtor address
|
|||
stateCode | string (9) | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | no | read close |
close
DescriptionStreet of debtor's address
|
|||
surname | string (70) | depends | read close |
close
DescriptionDebtor's last name
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionPrefix of the debtor's last name
|
|||
zip | string (10) | no | read close |
close
DescriptionZIP code of the debtor's address
|
|||
isRecurring | boolean | no | read close |
close
Description
|
|||
object | no | read close | |
close
DescriptionObject containing the details of the mandate approval
|
|||
mandateSignatureDate | string (8) | no | read close |
close
DescriptionThe date when the mandate was signed
Format: YYYYMMDD |
|||
mandateSignaturePlace | string (51) | no | read close |
close
DescriptionThe city where the mandate was signed
|
|||
mandateSigned | boolean | no | read close |
close
Description
|
|||
preNotification | string | no | read close |
close
DescriptionIndicates whether a pre-notification should be sent to the customer.
|
|||
encryptedCustomerInput | string | no | read close |
close
DescriptionData that was encrypted client side containing all customer entered data elements like card data.
Note: Because this data can only be submitted once to our system and contains encrypted card data you should not store it. As the data was captured within the context of a client session you also need to submit it to us before the session has expired. |
|||
paymentProductId | integer (5) | depends depends no no no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
Request example
This scenario you will probably use the most
-
billing_address = Address() billing_address.additional_info = 'Suite II' billing_address.city = 'Monument Valley' billing_address.country_code = 'US' billing_address.house_number = '1' billing_address.state = 'Utah' billing_address.street = 'Desertroad' billing_address.zip = '84536' company_information = CompanyInformation() company_information.name = 'Acme Labs' name = PersonalNameToken() name.first_name = 'Wile' name.surname = 'Coyote' name.surname_prefix = 'E.' personal_information = PersonalInformationToken() personal_information.name = name customer = CustomerToken() customer.billing_address = billing_address customer.company_information = company_information customer.merchant_customer_id = '1234' customer.personal_information = personal_information bank_account_bban = BankAccountBban() bank_account_bban.account_number = '000000123456' bank_account_bban.bank_code = '05428' bank_account_bban.branch_code = '11101' bank_account_bban.check_digit = 'X' bank_account_bban.country_code = 'IT' payment_product705_specific_data = TokenNonSepaDirectDebitPaymentProduct705SpecificData() payment_product705_specific_data.authorisation_id = '123456' payment_product705_specific_data.bank_account_bban = bank_account_bban mandate = MandateNonSepaDirectDebit() mandate.payment_product705_specific_data = payment_product705_specific_data non_sepa_direct_debit = TokenNonSepaDirectDebit() non_sepa_direct_debit.customer = customer non_sepa_direct_debit.mandate = mandate body = CreateTokenRequest() body.non_sepa_direct_debit = non_sepa_direct_debit body.payment_product_id = 705 response = client.v1().merchant('merchantId').tokens().create(body)
-
billing_address = Address() billing_address.country_code = 'US' customer = CustomerToken() customer.billing_address = billing_address card_without_cvv = CardWithoutCvv() card_without_cvv.card_number = '****************' card_without_cvv.expiry_date = '****' data = TokenCardData() data.card_without_cvv = card_without_cvv card = TokenCard() card.customer = customer card.data = data body = CreateTokenRequest() body.card = card body.payment_product_id = 1 response = client.v1().merchant('merchantId').tokens().create(body)
-
billing_address = Address() billing_address.additional_info = 'b' billing_address.city = 'Monument Valley' billing_address.country_code = 'US' billing_address.house_number = '13' billing_address.state = 'Utah' billing_address.street = 'Desertroad' billing_address.zip = '84536' company_information = CompanyInformation() company_information.name = 'Acme Labs' name = PersonalNameToken() name.first_name = 'Wile' name.surname = 'Coyote' name.surname_prefix = 'E.' personal_information = PersonalInformationToken() personal_information.name = name customer = CustomerToken() customer.billing_address = billing_address customer.company_information = company_information customer.merchant_customer_id = '1234' customer.personal_information = personal_information card_without_cvv = CardWithoutCvv() card_without_cvv.card_number = '****************' card_without_cvv.cardholder_name = 'Wile E. Coyote' card_without_cvv.expiry_date = '****' data = TokenCardData() data.card_without_cvv = card_without_cvv card = TokenCard() card.customer = customer card.data = data body = CreateTokenRequest() body.card = card body.payment_product_id = 1 response = client.v1().merchant('merchantId').tokens().create(body)
Responses
When we are able to tokenize the payment details two possible responses can occur:
- HTTP Response 200 is returned when you try to tokenize card details for a card that has already been tokenized in the past
- HTTP Response 201 is returned when the system successfully created a new token
Response 200 - OKCreateTokenResponse
An HTTP 200 response indicates that the card data was previously tokenized. The previous token is returned again. The evaluation regarding duplication is done purely on the card number. Please note that it is possible that the data other than the card number is different from the stored data, in that case you may need to update the token with the new data.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
isNewToken | boolean | no | read close |
close
DescriptionIndicates if a new token was created
|
|||
originalPaymentId | string | no | read close |
close
DescriptionThe initial Payment ID of the transaction from which the token has been created
|
|||
token | string | no | read close |
close
DescriptionID of the token
|
Response example
This scenario you will probably use the most
-
{ "isNewToken" : false, "token" : "49575a9c-5bd5-4539-a672-b5b4e7abf681" }
Response 201 - CreatedCreateTokenResponse
An HTTP 201 response indicates that the data was successfully tokenized and the newly created token is returned.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
isNewToken | boolean | no | read close |
close
DescriptionIndicates if a new token was created
|
|||
originalPaymentId | string | no | read close |
close
DescriptionThe initial Payment ID of the transaction from which the token has been created
|
|||
token | string | no | read close |
close
DescriptionID of the token
|
Response example
This scenario you will probably use the most
-
{ "isNewToken" : true, "token" : "49575a9c-5bd5-4539-a672-b5b4e7abf681" }
Response 400 - Bad requestErrorResponse
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
errorId | string | yes | read close |
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
array of object | yes | read close | |
close
DescriptionList of one or more errors
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
propertyName | string | no | read close |
close
DescriptionReturned 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:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
Response example
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 403 - UnauthorizedErrorResponse
When something is wrong with your credentials you will get a 403 response. This could happen when your account is not allowed to tokenize any payment data.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
errorId | string | yes | read close |
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
array of object | yes | read close | |
close
DescriptionList of one or more errors
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
propertyName | string | no | read close |
close
DescriptionReturned 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:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
Response example
This scenario you will probably use the most
-
{ "errorId" : "657b10da-d2f9-4088-a948-bf190ef516b1-000002b4", "errors" : [ { "code" : "700660", "message" : "SERVICE_NOT_ALLOWED" } ] }