Update token

PUT 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 PUT on a specific token to update the tokenized data. Any data that is supplied will overwrite any of the existing data in the token.

As the card number is used as a key this can't be updated. Instead of updating you should add a new token with the new card number. The same holds true of the payment product; this can not be updated.

The payload can, next to the paymentProductID contain one of the following types of objects to update tokenized data:

card data
SEPA Direct Debit data (including mandate information)
Non SEPA Direct Debit data
eWallet data

PayloadUpdateTokenRequest

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
Group card	object	one of the 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	depends	read close
close Description Object containing the details of the customer Depends on: Required for requests that will be processed by the GlobalCollect Payment platform. SDK Object type CustomerToken
billingAddress	object	no	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. 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 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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
countryCode	string (2)	no depends no yes no	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no	read close
close Description Full name of the state or province
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
zip	string	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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
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 customer
vatNumber	string (17)	depends	read close
close Description Local VAT number of the company Depends on: One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540: order.customer.personalInformation.dateOfBirth customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification
merchantCustomerId	string (15)	no	read close
close Description Your 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.
personalInformation	object	no	read close
close Description Object containing personal information of the customer SDK Object type PersonalInformationToken
name	object	no	read close
close Description Given name(s) or first name(s) of the customer SDK Object type PersonalNameToken
firstName	string (15)	no	read close
close Description Given name(s) or first name(s) of the customer
surname	string (70)	no	read close
close Description Surname(s) or last name(s) of the customer
surnamePrefix	string (15)	no	read close
close Description Middle name - In between first name and surname - of the customer
vatNumber	string (17)	no	read close
close Deprecated: Use companyInformation.vatNumber instead Description Local VAT number of the company
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). The minimum input length is 12 digits. Depends on: Required for Create and Update token.
cardholderName	string	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	one of the 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 customer SDK Object type CustomerToken
billingAddress	object	no	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. 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 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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
countryCode	string (2)	no depends no yes no	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no	read close
close Description Full name of the state or province
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
zip	string	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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
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 customer
vatNumber	string (17)	depends	read close
close Description Local VAT number of the company Depends on: One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540: order.customer.personalInformation.dateOfBirth customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification
merchantCustomerId	string (15)	no	read close
close Description Your 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.
personalInformation	object	no	read close
close Description Object containing personal information of the customer SDK Object type PersonalInformationToken
name	object	no	read close
close Description Given name(s) or first name(s) of the customer SDK Object type PersonalNameToken
firstName	string (15)	no	read close
close Description Given name(s) or first name(s) of the customer
surname	string (70)	no	read close
close Description Surname(s) or last name(s) of the customer
surnamePrefix	string (15)	no	read close
close Description Middle name - In between first name and surname - of the customer
vatNumber	string (17)	no	read close
close Deprecated: Use companyInformation.vatNumber instead Description Local VAT number of the company
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	one of the 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 customer SDK Object type CustomerToken
billingAddress	object	no	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. 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 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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
countryCode	string (2)	no depends no yes no	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no	read close
close Description Full name of the state or province
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
zip	string	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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
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 customer
vatNumber	string (17)	depends	read close
close Description Local VAT number of the company Depends on: One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540: order.customer.personalInformation.dateOfBirth customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification
merchantCustomerId	string (15)	no	read close
close Description Your 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.
personalInformation	object	no	read close
close Description Object containing personal information of the customer SDK Object type PersonalInformationToken
name	object	no	read close
close Description Given name(s) or first name(s) of the customer SDK Object type PersonalNameToken
firstName	string (15)	no	read close
close Description Given name(s) or first name(s) of the customer
surname	string (70)	no	read close
close Description Surname(s) or last name(s) of the customer
surnamePrefix	string (15)	no	read close
close Description Middle name - In between first name and surname - of the customer
vatNumber	string (17)	no	read close
close Deprecated: Use companyInformation.vatNumber instead Description Local VAT number of the company
mandate	object	yes	read close
close Description Object containing the mandate details SDK Object type MandateNonSepaDirectDebit
Group paymentProduct705SpecificData	object	one of the 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	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	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	no	read close
close Description Branch code
checkDigit	string	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	one of the 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	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	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	no	read close
close Description Branch code
checkDigit	string	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	one of the group	read close
close Description Object containing the SEPA Direct Debit details SDK Object type TokenSepaDirectDebitWithoutCreditor 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 customer 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 property within this object. SDK Object type Address
additionalInfo	string (50)	no	read close
close Description Additional 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 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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
countryCode	string (2)	no depends no yes no	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no	read close
close Description Full name of the state or province
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
zip	string	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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
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 customer
vatNumber	string (17)	depends	read close
close Description Local VAT number of the company Depends on: One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540: order.customer.personalInformation.dateOfBirth customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification
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 customer
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 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.
personalInformation	object	no	read close
close Description Object containing personal information of the customer SDK Object type PersonalInformationToken
name	object	no	read close
close Description Given name(s) or first name(s) of the customer SDK Object type PersonalNameToken
firstName	string (15)	no	read close
close Description Given name(s) or first name(s) of the customer
surname	string (70)	no	read close
close Description Surname(s) or last name(s) of the customer
surnamePrefix	string (15)	no	read close
close Description Middle name - In between first name and surname - of the customer
vatNumber	string (17)	no	read close
close Deprecated: Use companyInformation.vatNumber instead Description Local VAT number of the company
mandate	object	yes	read close
close Description Object containing the mandate details SDK Object type MandateSepaDirectDebitWithoutCreditor
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 property 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 (AfterPay Installments) in Austria (AT) and Germany (DE). Required for Create mandate and Create payment with mandate calls
customerContractIdentifier	string (35)	no	read close
close Description Identifies the contract between customer 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 property 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)	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3. The maximum length for paymentProductId 1503 (Boleto) is AN2. Depends on: Required for payments with paymentProductId 1503 (Boleto)
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
preNotification	string	no	read close
close Description Indicates whether a pre-notification should be sent to the customer. do-not-send - Do not send a pre-notification send-on-first-collection - Send a pre-notification
paymentProductId	integer (5)	depends	read close
close Description Payment product identifier Please see payment products for a full overview of possible values. Depends on: Required for requests that will be processed by the GlobalCollect Payment platform.

Request example

SDK: JSON

This scenario you will probably use the most

{
    "paymentProductId" : 1,
    "card" : {
        "data" : {
            "cardWithoutCvv" : {
                "cardholderName" : "Wile E. Coyote",
                "issueNumber" : "12",
                "expiryDate" : "1299",
                "cardNumber" : "4567350000427977"
            }
        },
        "customer" : {
            "merchantCustomerId" : "1234",
            "personalInformation" : {
                "name" : {
                    "surname" : "Coyote",
                    "surnamePrefix" : "E.",
                    "firstName" : "Wile"
                }
            },
            "billingAddress" : {
                "zip" : "84536",
                "street" : "Desertroad",
                "state" : "Utah",
                "countryCode" : "US",
                "houseNumber" : "13",
                "additionalInfo" : "b",
                "city" : "Monument Valley"
            },
            "companyInformation" : {
                "name" : "Acme Labs"
            }
        }
    }
}

{
    "paymentProductId" : 1,
    "card" : {
        "customer" : {
            "billingAddress" : {
                "countryCode" : "US"
            }
        },
        "data" : {
            "cardWithoutCvv" : {
                "cardNumber" : "****************",
                "expiryDate" : "****"
            }
        }
    }
}

{
    "paymentProductId" : 1,
    "card" : {
        "customer" : {
            "merchantCustomerId" : "1234",
            "personalInformation" : {
                "name" : {
                    "firstName" : "Wile",
                    "surnamePrefix" : "E.",
                    "surname" : "Coyote"
                }
            },
            "companyInformation" : {
                "name" : "Acme Labs"
            },
            "billingAddress" : {
                "street" : "Desertroad",
                "houseNumber" : "13",
                "additionalInfo" : "b",
                "zip" : "84536",
                "city" : "Monument Valley",
                "state" : "Utah",
                "countryCode" : "US"
            }
        },
        "data" : {
            "cardWithoutCvv" : {
                "cardNumber" : "****************",
                "expiryDate" : "****",
                "cardholderName" : "Wile E. Coyote"
            }
        }
    }
}

Responses

Please find below an overview of the possible responses.

Response 204 - No content

A 204 response denotes that we successfully processed the update request.

Response 400 - Bad requestErrorResponse

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
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 Description Contains detailed information on one single error. 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 customer 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: JSON

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"
        }
    ]
}

Update token

Tokens

Request

PayloadUpdateTokenRequest

Description

Description

Description

Depends on:

Description

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Description

Description

Description