Complete payment

POST https://{domainname}/v1/{merchantId}/payments/{paymentId}/complete

Payments

The payments REST services allow you to initiate a payment, retrieve the payment details or perform specific actions like refunding or requesting capture of a payment. A payment is identified by its paymentId. Some payment products allow a two step approach allowing you to control when the authorization takes place separate from when the funds are actually captured.

Request

Certain payment products use a two-step process to collect the required information to perform a payment. In these cases, the first step is to create a payment, the second is to complete it by calling this API. This API accepts a full payment object, but only specific properties will be required depending on the payment product.

Currently, only payment products Bancontact (3012), PayPal (840) and card payments that make use of 2-step 3D Secure use this flow.

For Bancontact the enhanced flow needs to be enabled, which allows consumers to pay via the Bancontact app. In this flow, you call Complete payment if the consumer does not use the app but enters the card details on your payment page.

For PayPal this API is used in the Express Checkout Shortcut flow that allows consumers to pre-select PayPal earlier in the checkout flow. This makes it possible for you to use billing and shipping details that are stored at PayPal. It separates the authentication of the user at PayPal from the transaction processing, which can then be done in the background. You call Complete payment when the redirect to PayPal was finished successful and you have all the right data (amounts) and are ready to capture the transaction.

If 2-Step 3D Secure is used for a card payment, the automatic authorization of funds will be disabled. Instead, the payment status will be PENDING_COMPLETION after the 3D Secure step. During this status you can call complete payment to authorize the payment. Once you have asked us to complete the payment, the authorization of the card will take place using the authentication data that was captured.

PayloadCompletePaymentRequest

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
cardPaymentMethodSpecificInput	object	depends	read close
close Description Object containing the specific input details for card payments Depends on: Required to complete a Bancontact (3012) payment SDK Object type CompletePaymentCardPaymentMethodSpecificInput
card	object	yes	read close
close Description Object containing card details 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 (51)	no	read close
close Description The card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
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)
merchant	object	no	read close
close Description Object containing information on you, the merchant SDK Object type Merchant
configurationId	string	no	read close
close Description In case your account has been setup with multiple configurations you can use this property to identify the one you would like to use for the transaction. Note that you can only submit preconfigured values in combination with the Worldline Online Payments Acceptance platform. In case no value is supplied a default value of 0 will be submitted to the Worldline Online Payments Acceptance platform. The Worldline Online Payments Acceptance platform internally refers to this as a PosId.
contactWebsiteUrl	string (2048)	no	read close
close Description URL to find contact or support details to contact in case of questions.
seller	object	no	read close
close Description Object containing seller details SDK Object type Seller
address	object	no	read close
close Description Object containing the seller 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 depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess 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 depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
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 depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends 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 payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. 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). Depends on: Required for cross-border merchants.
channelCode	string (3)	no	read close
close Description This property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.
description	string (32)	no	read close
close Description Description of the seller
externalReferenceId	string (15)	no	read close
close Description Seller ID assigned by the Merchant Aggregator
geocode	string (5)	no	read close
close Description The sellers geocode
id	string (40)	no depends no yes no	read close
close Description The sellers identifier Depends on: Required by the GlobalCollect platform.
invoiceNumber	string (12)	no	read close
close Description Invoice number of the payment
isForeignRetailer	boolean	no	read close
close Description Indicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values: true - The retailer is considered foreign because they are located in a different country than the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the marketplace is within the EEA and UK (and Gibraltar), but the retailer is located outside of the EEA and UK (and Gibraltar) false - The retailer is considered domestic because they are located in the same country as the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the retailer is also located within the EEA and UK (and Gibraltar).
mcc	string (5)	no	read close
close Description Merchant category code
name	string (128)	no depends no yes no	read close
close Description Name of the seller Depends on: Required by the GlobalCollect platform.
phoneNumber	string (32)	no	read close
close Description Main Phone Number
type	string	no depends no yes no	read close
close Description Seller type. Possible values: passport dni arg-identity-card civic-notebook enrollment-book cuil cuit general-register election-title cpf cnpj ssn citizen-ship col-identity-card alien-registration Depends on: Required by the GlobalCollect platform.
websiteUrl	string (60)	no depends no no yes	read close
close Description The website from which the purchase was made. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the TechProcess platform.
order	object	no	read close
close Description Order object containing order related data SDK Object type Order
additionalInput	object	no depends no depends yes	read close
close Description Object containing additional input on the order Depends on: Required by the GlobalCollect platform for payments done with payment product 120 - UATP. Required by the GlobalCollect platform for hosted checkouts where payment product 120 - UATP is allowed. Required by the TechProcess platform. Depends on: Required for payments done with payment product 120 - UATP. Required for hosted checkouts where payment product 120 - UATP is allowed. SDK Object type AdditionalOrderInput
accountFundingRecipient	object	depends	read close
close Description Object containing specific data regarding the recipient of an account funding transaction Depends on: Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. SDK Object type AccountFundingRecipient
accountNumber	string (50)	depends	read close
close Description Should be populated with the value of the corresponding accountNumberType of the recipient. Depends on: Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995 when order.additionalInput.accountFundingRecipient.accountNumberType is routingNumber, IBAN or bicNumber. When order.additionalInput.accountFundingRecipient.accountNumberType is set to cash then this property can be empty. When order.additionalInput.accountFundingRecipient.accountNumberType is set to giftCard then Gift card number to be filled.
accountNumberType	string	depends	read close
close Description Defines the account number type of the recipient. Possible values are: cash = Mode of payment is cash to the recipient. walletId = Digital wallet ID. routingNumber = Routing Transit Number is a code used by financial institutions to identify other financial institutions. iban = International Bank Account Number, is a standard international numbering system for identifying bank accounts. bicNumber = Bank Identification Code is a number that is used to identify a specific bank. giftCard = Gift card is a type of prepaid card that contains a specific amount of money that can be used at participating stores and marketplaces. Depends on: Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995 when order.additionalInput.accountFundingRecipient.accountNumber is provided.
address	object	no	read close
close Description Object containing the address details of the recipient of an account funding transaction. 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 depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess 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 depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
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 depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends 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 payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. 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). Depends on: Required for cross-border merchants.
dateOfBirth	string (8)	depends	read close
close Description The date of birth of the recipient Format: YYYYMMDD Depends on: Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
name	object	depends	read close
close Description Object containing the name details of the recipient of an account funding transaction. Depends on: Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. SDK Object type AfrName
firstName	string (15)	yes	read close
close Description Given name(s) or first name(s) of the recipient of an account funding transaction.
surname	string (70)	yes	read close
close Description Surname(s) or last name(s) of the customer
partialPan	string (10)	depends	read close
close Description Either partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers. Depends on: Should be filled with the first 6 and last 4 digits of the PAN number of the recipient of the loan.
airlineData	object	no depends no depends depends	read close
close Description Object that holds airline specific data Depends on: Required by the GlobalCollect platform for payments done with payment product 120 - UATP. Required by the GlobalCollect platform for hosted checkouts where payment product 120 - UATP is allowed. Required by the TechProcess platform for airline merchants. Depends on: Required for payments done with payment product 120 - UATP. Required for hosted checkouts where payment product 120 - UATP is allowed. Depends on: Required for airline merchants. SDK Object type AirlineData
agentNumericCode	string (8)	no	read close
close Description Numeric code identifying the agent
code	string (3)	no	read close
close Description Airline numeric code
flightDate	string (8)	no depends no no depends	read close
close Description Date of the Flight Format: YYYYMMDD Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
flightLegs	array of object	no depends no no depends	read close
close Description Object that holds the data on the individual legs of the ticket Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
items	object	no	read close
close SDK Object type AirlineFlightLeg
airlineClass	string	no	read close
close Description Reservation Booking Designator
arrivalAirport	string (3)	no depends no no depends	read close
close Description Arrival airport/city code Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
arrivalTime	string	no	read close
close Description The arrival time in the local time zone Format: HH:MM
carrierCode	string (2)	no	read close
close Description IATA carrier code
conjunctionTicket	string (14)	no	read close
close Description Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
couponNumber	string (1)	no	read close
close Description The coupon number associated with this leg of the trip. A ticket can contain several legs of travel, and each leg of travel requires a separate coupon
date	string (8)	no depends no no depends	read close
close Description Date of the leg Format: YYYYMMDD Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
departureTime	string (6)	depends	read close
close Description The departure time in the local time at the departure airport Format: HH:MM Depends on: Required for PayPal (840) when Airline data is submitted
endorsementOrRestriction	string (20)	no	read close
close Description An endorsement can be an agency-added notation or a mandatory government required notation, such as value-added tax. A restriction is a limitation based on the type of fare, such as a ticket with a 3-day minimum stay
exchangeTicket	string (15)	no	read close
close Description New ticket number that is issued when a ticket is exchanged
fare	string (12)	no	read close
close Description Fare of this leg
fareBasis	string (15)	no	read close
close Description Fare Basis/Ticket Designator
fee	integer	no	read close
close Description Fee for this leg of the trip
flightNumber	string (4)	depends	read close
close Description The flight number assigned by the airline carrier with no leading spaces Should be a numeric string Depends on: Required for PayPal (840) when Airline data is submitted
number	integer (5)	no	read close
close Description Sequence number of the flight leg
originAirport	string (3)	no depends no no depends	read close
close Description Origin airport/city code Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
passengerClass	string	no	read close
close Description PassengerClass if this leg
serviceClass	enum	no	read close
close Deprecated: Use passengerClass instead Description ServiceClass of this leg (this property is used for fraud screening on the Ogone Payment Platform). Possible values are: economy premium-economy business first
stopoverCode	string	depends	read close
close Description Possible values are: permitted = Stopover permitted non-permitted = Stopover not permitted Depends on: Required for PayPal (840) when Airline data is submitted
taxes	integer	no	read close
close Description Taxes for this leg of the trip
invoiceNumber	string (6)	no	read close
close Description Airline tracing number
isETicket	boolean	no	read close
close Description true = The ticket is an E-Ticket false = the ticket is not an E-Ticket
isRegisteredCustomer	boolean	no	read close
close Deprecated: Use order.customer.accountType instead Description true = a registered known customer false = unknown customer
isRestrictedTicket	boolean	no	read close
close Description true - Restricted, the ticket is non-refundable false - No restrictions, the ticket is (partially) refundable
isThirdParty	boolean	no	read close
close Description true - The payer is the ticket holder false - The payer is not the ticket holder
issueDate	string (8)	no	read close
close Description This is the date of issue recorded in the airline system In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date. Format: YYYYMMDD
merchantCustomerId	string (16)	no	read close
close Description Your ID of the customer in the context of the airline data
name	string (20)	no	read close
close Description Name of the airline
numberInParty	integer	no	read close
close Description Total number of passengers in the party. If the the property numberInParty is not present, then the number of passengers will be used on the WL Online Payment Acceptance Platform.
passengerName	string (49)	no depends no no depends	read close
close Description Name of passenger Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
passengers	array of object	no	read close
close Description Object that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
items	object	no	read close
close SDK Object type AirlinePassenger
firstName	string (15)	no	read close
close Description First name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
surname	string (70)	no	read close
close Description Surname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
surnamePrefix	string (15)	no	read close
close Description Surname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
title	string (35)	no	read close
close Description Title of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
placeOfIssue	string (15)	no	read close
close Description Place of issue For sales in the US the last two characters (pos 14-15) must be the US state code.
pnr	string (127)	no depends no no depends	read close
close Description Passenger name record Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
pointOfSale	string (25)	no	read close
close Description IATA point of sale name
posCityCode	string (10)	no	read close
close Description city code of the point of sale
ticketDeliveryMethod	string	no	read close
close Description Possible values: e-ticket city-ticket-office airport-ticket-office ticket-by-mail ticket-on-departure
ticketNumber	string (13)	no	read close
close Description The ticket or document number. On the Ogone Payment Platform and the GlobalCollect Payment Platform it contains: Airline code: 3-digit airline code number Form code: A maximum of 3 digits indicating the type of document, the source of issue and the number of coupons it contains Serial number: A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits allocated to the form code and serial number shall not exceed ten TICKETNUMBER can be replaced with PNR if the ticket number is unavailable
totalFare	integer	no	read close
close Description Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets
totalFee	integer	no	read close
close Description Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
totalTaxes	integer	no	read close
close Description Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
travelAgencyName	string (25)	no	read close
close Description Name of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.
installments	object	no	read close
close Description Object containing data related to installments which can be used for card payments and only with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages. SDK Object type Installments
amountOfMoneyPerInstallment	object	no	read close
close Description The amount that will be paid per installment. The total amount of amountOfMoneyPerInstallment x numberOfInstallments can not be higher than the total amount of this transaction, although we will not validate that. For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
amountOfMoneyTotal	object	no	read close
close Description Object containing the total amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
frequencyOfInstallments	string	no	read close
close Description The frequency in which the installments will be collected from the customer. The possible values are: daily weekly monthly (default) quarterly For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), only the value monthly is valid.
installmentPlanCode	integer	no	read close
close Description The code for the installment plan. The possible values are: 43 No-interest, 3 month Installmentplan 46No-interest, 6 month Installmentplan 49No-interest, 9 month Installmentplan 52No-interest, 12 month Installmentplan
interestRate	string	no	read close
close Description The interest rate paid for installments expressed in percentage. So for example 5.75 means 5.75% For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer.
numberOfInstallments	integer (5)	no depends no yes no	read close
close Description The number of installments in which this transaction will be paid, which can be used for card payments at supported acquirers, or with specific payment products. Only used with some acquirers. In case you send in the details of this object, only the payment products (or combination of card products and acquirers) that support installments will be shown on the MyCheckout hosted payment pages. If this property is not provided the customer will not see details on the installment plan in a HostedCheckout. For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), there is a maximum of 12 installments. Depends on: Required by the GlobalCollect platform.
level3SummaryData	object	no	read close
close Deprecated: Use order.shoppingCart.amountBreakdown instead Description Object that holds Level3 summary data SDK Object type Level3SummaryData
discountAmount	integer (12)	no	read close
close Deprecated: Use order.shoppingCart.amountBreakdown with type DISCOUNT instead Description Discount on the entire transaction, with the last 2 digits are implied decimal places
dutyAmount	integer (12)	no	read close
close Deprecated: Use order.shoppingCart.amountBreakdown with type DUTY instead Description Duty on the entire transaction, with the last 2 digits are implied decimal places
shippingAmount	integer (12)	no	read close
close Deprecated: Use order.shoppingCart.amountBreakdown with type SHIPPING instead Description Shippingcost on the entire transaction, with the last 2 digits are implied decimal places
loanRecipient	object	depends	read close
close Deprecated: No replacement Description Object containing specific data regarding the recipient of a loan in the UK Depends on: Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers. SDK Object type LoanRecipient
accountNumber	string (10)	depends	read close
close Deprecated: No replacement Description Should be filled with the last 10 digits of the bank account number of the recipient of the loan. Depends on: Either partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
dateOfBirth	string (8)	depends	read close
close Deprecated: No replacement Description The date of birth of the customer of the recipient of the loan. Format: YYYYMMDD Depends on: Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
partialPan	string (10)	depends	read close
close Deprecated: No replacement Description Should be filled with the first 6 and last 4 digits of the PAN number of the recipient of the loan. Depends on: Either partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
surname	string (12)	depends	read close
close Deprecated: No replacement Description Surname of the recipient of the loan. Depends on: Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
zip	string (10)	depends	read close
close Deprecated: No replacement Description Zip code of the recipient of the loan Depends on: Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
lodgingData	object	no	read close
close Description Object that holds lodging specific data SDK Object type LodgingData
charges	array of object	no	read close
close Description Object that holds lodging related charges
items	object	no	read close
close SDK Object type LodgingCharge
chargeAmount	integer (12)	no	read close
close Description Amount of additional charges associated with the stay of the guest. Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
chargeAmountCurrencyCode	string (3)	no	read close
close Description Currency for Charge amount. The code should be in 3 letter ISO format.
chargeType	string	no	read close
close Description Type of additional charges associated with the stay of the guest. Allowed values: lodging telephone restaurant minibar giftshop laundry transport gratuity conferenceRoom audiovisual banquet internet earlyDeparture roomService loungeBar other
checkInDate	string (8)	no	read close
close Description The date the guest checks into (or plans to check in to) the facility. Format: YYYYMMDD
checkOutDate	string (8)	no	read close
close Description The date the guest checks out of (or plans to check out of) the facility. Format: YYYYMMDD
folioNumber	string (25)	no	read close
close Description The Lodging Folio Number assigned to the itemized statement of charges and credits associated with this lodging stay, which can be any combination of characters and numerals defined by the Merchant or authorized Third Party Processor.
isConfirmedReservation	boolean	no	read close
close Description Indicates whether the room reservation is confirmed. true - The room reservation is confirmed false - The room reservation is not confirmed
isFacilityFireSafetyConform	boolean	no	read close
close Description Defines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation. true - The facility conform to the requirements false - The facility doesn't conform to the requirements
isNoShow	boolean	no	read close
close Description Indicate if this the customer is a no show case. In such case, the lodging property can charge a no show fee. true - The customer is a no show false - Not applicable
isPreferenceSmokingRoom	boolean	no	read close
close Description Indicated the preference of the customer for a smoking or non-smoking room. true - A smoking room is preferred false - A non-smoking room is preferred
numberOfAdults	integer (3)	no	read close
close Description The total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)
numberOfNights	integer (4)	no	read close
close Description The number of nights for the lodging stay
numberOfRooms	integer (4)	no	read close
close Description The number of rooms rented for the lodging stay
programCode	string	no	read close
close Description Code that corresponds to the category of lodging charges detailed in this message. Allowed values: lodging - (Default) Submitted charges are for lodging noShow - Submitted charges are for the failure of the guest(s) to check in for reserved a room advancedDeposit - Submitted charges are for an Advanced Deposit to reserve one or more rooms If no value is submitted the default value lodging is used.
propertyCustomerServicePhoneNumber	string (20)	no	read close
close Description The international customer service phone number of the facility
propertyPhoneNumber	string (20)	no	read close
close Description The local phone number of the facility in an international phone number format
renterName	string (26)	no	read close
close Description Name of the person or business entity charged for the reservation and/or lodging stay
rooms	array of object	no	read close
close Description Object that holds lodging related room data
items	object	no	read close
close SDK Object type LodgingRoom
dailyRoomRate	string (12)	no	read close
close Description Daily room rate exclusive of any taxes and fees Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
dailyRoomRateCurrencyCode	string (3)	no	read close
close Description Currency for Daily room rate. The code should be in 3 letter ISO format
dailyRoomTaxAmount	string (12)	no	read close
close Description Daily room tax Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
dailyRoomTaxAmountCurrencyCode	string (3)	no	read close
close Description Currency for Daily room tax. The code should be in 3 letter ISO format
numberOfNightsAtRoomRate	integer (4)	no	read close
close Description Number of nights charged at the rate in the dailyRoomRate property
roomLocation	string (10)	no	read close
close Description Location of the room within the facility, e.g. Park or Garden etc.
roomNumber	string (6)	no	read close
close Description Room number
typeOfBed	string (12)	no	read close
close Description Size of bed, e.g., king, queen, double.
typeOfRoom	string (12)	no	read close
close Description Describes the type of room, e.g., standard, deluxe, suite.
numberOfInstallments	integer (5)	no	read close
close Deprecated: Use installments.numberOfInstallments instead. Description The number of installments in which this transaction will be paid, which can be used for card payments. Only used with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages.
orderDate	string (14)	no	read close
close Description Date and time of order Format: YYYYMMDDHH24MISS
typeInformation	object	no	read close
close Description Object that holds the purchase and usage type indicators SDK Object type OrderTypeInformation
fundingType	string	depends	read close
close Description Identifies the funding type being authenticated. Possible values are: personToPerson = When it is person to person funding (P2P) agentCashOut = When fund is being paid out to final recipient in Cash by company's agent. businessToConsumer = When fund is being transferred from business to consumer (B2C) businessToBusiness = When fund is being transferred from business to business (B2B) prefundingStagedWallet = When funding is being used to load the funds into the wallet account. storedValueDigitalWallet = When funding is being used to load the funds into a stored value digital wallet. fundingGiftCardForPersonalUse = When funding a gift card for personal use. fundingGiftCardForSomeoneElse = When funding a gift card for someone else. Depends on: Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995.
paymentCode	string	no	read close
close Description Payment code to support account funding transactions. Possible values are: accountManagement paymentAllowance settlementOfAnnuity unemploymentDisabilityBenefit businessExpenses bonusPayment busTransportRelatedBusiness cashManagementTransfer paymentOfCableTVBill governmentInstituteIssued creditCardPayment creditCardBill charity collectionPayment commercialPayment commission compensation copyright debitCardPayment deposit dividend studyFees electricityBill energies generalFees ferry foreignExchange gasBill unemployedCompensation governmentPayment healthInsurance reimbursementCreditCard reimbursementDebitCard carInsurancePremium insuranceClaim installment insurancePremium investmentPayment intraCompany interest incomeTax investment laborInsurance licenseFree lifeInsurance loan medicalServices mobilePersonToBusiness mobilePersonToPerson mobileTopUp notSpecified other anotherTelecomBill payroll pensionFundContribution pensionPayment telephoneBill propertyInsurance generalLease rent railwayPayment royalties salary savingsPayment securities socialSecurity study subscription supplierPayment taxRefund taxPayment telecommunicationsBill tradeServices treasuryPayment travelPayment utilityBill valueAddedTaxPayment withHolding waterBill .
purchaseType	string	no	read close
close Description Possible values are: physical digital
transactionType	string	depends	read close
close Description Identifies the type of transaction being authenticated. Possible values are: purchase = The purpose of the transaction is to purchase goods or services (Default) check-acceptance = The purpose of the transaction is to accept a 'check'/'cheque' account-funding = The purpose of the transaction is to fund an account quasi-cash = The purpose of the transaction is to buy a quasi cash type product that is representative of actual cash such as money orders, traveler's checks, foreign currency, lottery tickets or casino gaming chips prepaid-activation-or-load = The purpose of the transaction is to activate or load a prepaid card Depends on: Required for merchants from Brazil in case order.amountOfMoney.amount is not 0. Merchants with MCC codes (V4829, V6012, M4829, V6051, M6540, 7995) need to indicate the transaction as account-funding.
usageType	string	no	read close
close Description Possible values are: private commercial
amountOfMoney	object	yes	read close
close Description Object containing amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
customer	object	depends	read close
close Description Object containing the details of the customer Depends on: Required, except when a token has been included in the request that includes at least the countryCode in the billingAddress. SDK Object type Customer
account	object	no	read close
close Description Object containing data related to the account the customer has with you SDK Object type CustomerAccount
authentication	object	no	read close
close Description Object containing data on the authentication used by the customer to access their account SDK Object type CustomerAccountAuthentication
data	string (20000)	no	read close
close Description Data that documents and supports a specific authentication process submitted using the order.customer.account.authentication.method property. The data submitted using this property will be used by the issuer to validate the used authentication method. For example, if the order.customer.account.authentication.method is: federated-id, then this element can carry information about the provider of the federated ID and related information. fido-authentication, then this element can carry the FIDO attestation data (including the signature). fido-authentication-with-signed-assurance-data, then this element can carry FIDO Attestation data with the FIDO assurance data signed. src-assurance-data, then this element can carry the SRC assurance data
method	string	depends	read close
close Description Authentication used by the customer on your website or app Possible values : guest = no login occurred, customer is 'logged in' as guest merchant-credentials = the customer logged in using credentials that are specific to you federated-id = the customer logged in using a federated ID issuer-credentials = the customer logged in using credentials from the card issuer (of the card used in this transaction) third-party-authentication = the customer logged in using third-party authentication fido-authentication = the customer logged in using a FIDO authenticator fido-authentication-with-signed-assurance-data = the customer logged in using a FIDO authenticator which also provides signed assurance data src-assurance-data = the customer authenticated themselves during a Secure Remote Commerce session Depends on: Required when order.customer.account.authentication.data is provided.
utcTimestamp	string (12)	no	read close
close Description Timestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
changeDate	string (8)	no	read close
close Description The last date (YYYYMMDD) on which the customer made changes to their account with you. These are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.
changedDuringCheckout	boolean	no	read close
close Description true = the customer made changes to their account during this checkout false = the customer didn't change anything to their account during this checkout/n The changes ment here are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.
createDate	string (8)	no	read close
close Description The date (YYYYMMDD) on which the customer created their account with you
hadSuspiciousActivity	boolean	no	read close
close Description Specifies if you have experienced suspicious activity on the account of the customer true = you have experienced suspicious activity (including previous fraud) on the customer account used for this transaction false = you have experienced no suspicious activity (including previous fraud) on the customer account used for this transaction
hasForgottenPassword	boolean	no	read close
close Description Specifies if the customer (initially) had forgotten their password true - The customer has forgotten their password false - The customer has not forgotten their password
hasPassword	boolean	no	read close
close Description Specifies if the customer entered a password to gain access to an account registered with the you true - The customer has used a password to gain access false - The customer has not used a password to gain access
passwordChangeDate	string (8)	no	read close
close Description The last date (YYYYMMDD) on which the customer changed their password for the account used in this transaction
passwordChangedDuringCheckout	boolean	no	read close
close Description Indicates if the password of an account is changed during this checkout true = the customer made changes to their password of the account used during this checkout alse = the customer didn't change anything to their password of the account used during this checkout
paymentAccountOnFile	object	no	read close
close Description Object containing information on the payment account data on file (tokens) SDK Object type PaymentAccountOnFile
createDate	string (8)	no	read close
close Description The date (YYYYMMDD) when the payment account on file was first created. In case a token is used for the transaction we will use the creation date of the token in our system in case you leave this property empty.
numberOfCardOnFileCreationAttemptsLast24Hours	integer (3)	no	read close
close Description Number of attempts made to add new card to the customer account in the last 24 hours
paymentAccountOnFileType	string	depends	read close
close Description Indicates the type of account. For example, for a multi-account card product. not-applicable = the card used doesn't support multiple card products credit = the card used is a credit card debit = the card used is a debit card Depends on: Required for merchants in Brazil
paymentActivity	object	no	read close
close Description Object containing data on the purchase history of the customer with you SDK Object type CustomerPaymentActivity
numberOfPaymentAttemptsLast24Hours	integer (3)	no	read close
close Description Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours
numberOfPaymentAttemptsLastYear	integer (3)	no	read close
close Description Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months
numberOfPurchasesLast6Months	integer (4)	no	read close
close Description Number of successful purchases made by this customer with you in the last 6 months
accountType	string	no	read close
close Description Type of the customer account that is used to place this order. Can have one of the following values: none - The account that was used to place the order with is a guest account or no account was used at all created - The customer account was created during this transaction existing - The customer account was an already existing account prior to this transaction
billingAddress	object	depends	read close
close Description Object containing billing address details Depends on: Required, except when a token has been included in the request that includes at least the countryCode. For Direct Debit UK (705) the city, street and zip properties are also required, except when a token has been included in the request that includes these properties. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540. Required for cross-border TechProcess merchants. 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 depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess 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 depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
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 depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends 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 payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. 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). Depends on: Required for cross-border merchants.
companyInformation	object	depends depends no no depends	read close
close Description Object containing company information Depends on: Required for payments when the property order.customer.fiscalNumber is set to: Argentina: Company (CUIT) - 11 digits Brazil: Company (CNPJ) - 14 digits Depends on: Required by the WOPA platform for payments when the property order.customer.fiscalNumber is set to: Argentina: Company (CUIT) - 11 digits Brazil: Company (CNPJ) - 14 digits Required by the TechProcess platform for cross-border payments when the property order.customer.isCompany is set to true. Depends on: Required for cross-border payments when the property order.customer.isCompany is set to true. SDK Object type CompanyInformation
dateOfIncorporation	string (8)	no depends no no depends	read close
close Description The date of incorporation is the specific date when the company was registered with the relevant authority. Format: YYYYMMDD Depends on: Required by the TechProcess platform for cross-border payments when the property order.customer.isCompany is set to true. Depends on: Required for cross-border payments when the property order.customer.isCompany is set to true.
name	string (40)	depends depends no no no	read close
close Description Name of company, as a customer Depends on: Required for payments when the property order.customer.fiscalNumber is set to: Argentina: Company (CUIT) - 11 digits. Brazil: Company (CNPJ) - 14 digits. Depends on: Required by the WOPA platform for payments when the property order.customer.fiscalNumber is set to: Argentina: Company (CUIT) - 11 digits. Brazil: Company (CNPJ) - 14 digits.
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, 7995: 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	depends depends no depends yes	read close
close Description Object containing contact details like email address and phone number Depends on: Required for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), China UnionPay (paymentProductId 869), AfterPay Installments (paymentProductId 9000) or AfterPay Invoice (paymentProductId 9001). Required for payments with product BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). Required by the WOPA platform for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). Required by the TechProcess platform. Depends on: Required for payments with Trustly (paymentProductId 806), China UnionPay (paymentProductId 869), AfterPay Installments (paymentProductId 9000) or AfterPay Invoice (paymentProductId 9001). Required for payments with product BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). SDK Object type ContactDetails
emailAddress	string (70)	depends depends no depends depends	read close
close Description Email address of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Required by the WOPA platform for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Depends on: Required for payments.
emailMessageType	string	no	read close
close Description Preference for the type of email message markup plain-text html
faxNumber	string (20)	no	read close
close Description Fax number of the customer
mobilePhoneNumber	string (20)	depends depends no depends depends	read close
close Description International version of the mobile phone number of the customer including the leading + (i.e. +16127779311). Depends on: Required for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104) or Pix (paymentProductId 6105) if phoneNumber is not provided. Depends on: Required by the GlobalCollect platform for Create Payments API calls for paymentProductId 869 (China UnionPay). Optional for other cases like Create hostedCheckouts API calls, even when using paymentProductId 869 (China UnionPay) on the payment pages as the customer will be asked to fill this in. Required for payments with product BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Required by the WOPA platform for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104) or Pix (paymentProductId 6105) if phoneNumber is not provided. Required by the TechProcess platform for for cross-border payments. Depends on: Required for Create Payments API calls for paymentProductId 869 (China UnionPay). Optional for other cases like Create hostedCheckouts API calls, even when using paymentProductId 869 (China UnionPay) on the payment pages as the customer will be asked to fill this in. Required for payments with product BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Depends on: Required for for cross-border payments.
phoneNumber	string (20)	depends depends no depends depends	read close
close Description Phone number of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul) or 6104 (Bradesco) if mobilePhoneNumber is not provided. Depends on: Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments), 9001 (AfterPay Invoice), 1504 (Konbini). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul) or 6104 (Bradesco) if mobilePhoneNumber is not provided. Required by the TechProcess platform for payments. Depends on: Required for payments with product 9000 (AfterPay Installments), 9001 (AfterPay Invoice), 1504 (Konbini). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Depends on: Required for payments.
workPhoneNumber	string (20)	no depends no depends no	read close
close Description International version of the work phone number of the customer including the leading + (i.e. +31235671500) Depends on: Required by the GlobalCollect platform for payments. One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Depends on: Required for payments. One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber
device	object	depends depends no no depends	read close
close Description Object containing information on the device and browser of the customer Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the TechProcess platform for payments. Depends on: Required for payments. SDK Object type CustomerDevice
acceptHeader	string (2048)	depends	read close
close Description The accept-header of the customer client from the HTTP Headers. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
browserData	object	depends depends no no no	read close
close Description Object containing information regarding the browser of the customer Depends on: Required for Required for 3-D Secure version 2 for the browser flow. Depends on: Required by the WOPA platform for Required for 3-D Secure version 2 for the browser flow. SDK Object type BrowserData
colorDepth	integer (2)	depends	read close
close Description ColorDepth in bits. Value is returned from the screen.colorDepth property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
innerHeight	string (6)	no	read close
close Description The innerHeight of the frame in case you are capturing your payments in a frame. We will use this to validate if the height provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.
innerWidth	string (6)	no	read close
close Description The innerWidth of the frame in case you are capturing your payments in a frame. We will use this to validate if the width provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.
javaEnabled	boolean	depends	read close
close Description true =Java is enabled in the browser false = Java is not enabled in the browser Value is returned from the navigator.javaEnabled property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
javaScriptEnabled	boolean	depends	read close
close Description true = JavaScript is enabled in the browser false = JavaScript is not enabled in the browser Note: Required in future 3-D Secure version 2.2. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
screenHeight	string (6)	depends	read close
close Description Height of the screen in pixels. Value is returned from the screen.height property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
screenWidth	string (6)	depends	read close
close Description Width of the screen in pixels. Value is returned from the screen.width property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
defaultFormFill	string	no	read close
close Description Degree of default form fill, with the following possible values: automatically - All fields filled automatically automatically-but-modified - All fields filled automatically, but some fields were modified manually manually - All fields were entered manually
deviceFingerprintTransactionId	string	no	read close
close Description One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
ipAddress	string (45)	depends depends depends depends depends	read close
close Description The IP address of the customer client from the HTTP Headers. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required by the GlobalCollect platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the Ogone platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the TechProcess platform for payments. Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for payments.
locale	string (8)	depends depends depends depends no	read close
close Description Locale of the client device/browser. Returned in the browser from the navigator.language property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required by the GlobalCollect platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the Ogone platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser".
timezoneOffsetUtcMinutes	string (6)	depends depends depends depends no	read close
close Description Offset in minutes of timezone of the client versus the UTC. Value is returned by the JavaScript getTimezoneOffset() Method. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required by the GlobalCollect platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the Ogone platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser".
userAgent	string (2048)	depends depends depends depends depends	read close
close Description User-Agent of the client device/browser from the HTTP Headers. As a fall-back we will use the userAgent that might be included in the encryptedCustomerInput, but this is captured client side using JavaScript and might be different. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required by the GlobalCollect platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the Ogone platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the TechProcess platform for payments. Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for payments.
fiscalNumber	string (14)	depends	read close
close Description The fiscal registration number of the customer or the tax registration number of the company in case of a business customer. Please find below specifics per country: Argentina - Consumer (DNI) with a length of 7 or 8 digits Argentina - Company (CUIT) with a length of 11 digits Brazil - Consumer (CPF) with a length of 11 digits Brazil - Company (CNPJ) with a length of 14 digits Chile - Consumer (RUT) with a length of 9 digits Colombia - Consumer (NIT) with a length of 8, 9 or 10 digits Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits Dominican Republic - Consumer (RNC) with a length of 11 digits Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU)) with a length of 11 characters India - Consumer (PAN) with a length of 10 characters Mexico - Consumer (RFC) with a length of 13 digits Mexico - Company (RFC) with a length of 12 digits Norway - Consumer (fødselsnummer) with a length of 11 digits Peru - Consumer (RUC) with a length of 11 digits Sweden - Consumer (personnummer) with a length of 10 or 12 digits Uruguay - Consumer (CI) with a length of 8 digits Uruguay - Consumer (NIE) with a length of 9 digits Uruguay - Company (RUT) with a length of 12 digits Depends on: Required for payments done with payment products: 51 - Deposito Identificado 1503 - Boleto Bancario 840 - PayPal, but only for transactions done in Brazil 9000 - AfterPay Installments and 9001 - AfterPay Invoice, but only for transactions done in Denmark, Finland, Norway and Sweden 6101 - Banco do Brasil 6102 - Itaú 6103 - Banrisul 6104 - Bradesco 6105 - Pix 6107 - PicPay Required for cross-border TechProcess merchants.
isCompany	boolean	no	read close
close Description Indicates if the payer is a company or an individual true = This is a company false = This is an individual
isPreviousCustomer	boolean	no	read close
close Description Specifies if the customer has a history of online shopping with the merchant true - The customer is a known returning customer false - The customer is new/unknown customer
locale	string (6)	depends	read close
close Description The locale that the customer should be addressed in (for 3rd parties). Note that some 3rd party providers only support the languageCode part of the locale, in those cases we will only use part of the locale provided. Depends on: This property is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
merchantCustomerId	string (15)	depends	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. Depends on: Required for payments done with payment product 320 (Google Pay), payment product 806 (Trustly), 830 (paysafecard) and 865 (Worldline Account-to-Account Payments). Required for hosted checkouts where payment products 806 (Trustly), 830 (PaysafeCard) and 865 (Worldline Account-to-Account Payments) are allowed. Required for card payments and hosted checkouts with the unscheduledCardOnFileSequenceIndicator or unscheduledCardOnFileRequestor property set.
personalInformation	object	depends depends no depends depends	read close
close Description Object containing personal information like name, date of birth and gender. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Depends on: Required for payments. SDK Object type PersonalInformation
dateOfBirth	string (8)	no depends no depends depends	read close
close Description The date of birth of the customer Format: YYYYMMDD Depends on: Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification Required by the TechProcess platform for cross-border payments when the property order.customer.isCompany is set to false. Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification Depends on: Required for cross-border payments when the property order.customer.isCompany is set to false.
gender	string	no	read close
close Description The gender of the customer, possible values are: male female unknown or empty
identification	object	depends	read close
close Description Object containing identification documents information Depends on: One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification SDK Object type PersonalIdentification
idIssuingCountryCode	string (2)	yes	read close
close Description ISO 3166-1 alpha-2 country code of the country that issued the identification document
idType	string	yes	read close
close Description Indicates the type of identification nationalIdentification = The provided idValue is a national identification number. passportNumber = The provided idValue is a passport number. driverLicense = The provided idValue is driving License of the individual. companyRegistrationNumber = The provided idValue is a company identifier. It verifies its legal existence as an incorporated entity. socialSecurityNumber =n The provided idValue is a social security number, issued to an individual by the individual's government. alienRegistrationNumber = The provided idValue is an alien registration number, provided by immigration services of a country. lawEnforcementIdentification = The provided idValue is an alien registration number, provided by immigration services of a country. militaryIdentification = The provided idValue is an identification issued to military personnel of a country.
idValue	string (70)	yes	read close
close Description The value of the identification
name	object	depends depends no depends depends	read close
close Description Object containing the name details of the customer Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for payments. SDK Object type PersonalName
firstName	string (15)	depends depends no depends depends	read close
close Description Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for payments.
surname	string (70)	depends depends depends depends depends	read close
close Description Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Required by the Ogone platform for the creation of a Payout. Required by the TechProcess platform for the creation of a payment. Depends on: Required for the creation of a Payout. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for the creation of a payment.
surnamePrefix	string (15)	no	read close
close Description Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
title	string (35)	depends	read close
close Description Title of customer Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
shippingAddress	object	no	read close
close Deprecated: Use order.shipping.address instead Description Object containing shipping address details SDK Object type AddressPersonal
additionalInfo	string (50)	no	read close
close Deprecated Description Additional address information
city	string	no depends no no depends	read close
close Deprecated Description City Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no no depends	read close
close Deprecated Description ISO 3166-1 alpha-2 country code Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
houseNumber	string (15)	no	read close
close Deprecated Description House number
name	object	no depends no no depends	read close
close Deprecated Description Object that holds the name elements Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants. SDK Object type PersonalName
firstName	string (15)	depends depends no depends depends	read close
close Deprecated Description Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for payments.
surname	string (70)	depends depends depends depends depends	read close
close Deprecated Description Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Required by the Ogone platform for the creation of a Payout. Required by the TechProcess platform for the creation of a payment. Depends on: Required for the creation of a Payout. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for the creation of a payment.
surnamePrefix	string (15)	no	read close
close Deprecated Description Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
title	string (35)	depends	read close
close Deprecated Description Title of customer Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
state	string (35)	no depends no no depends	read close
close Deprecated Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Deprecated 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)
street	string (50)	no depends no depends depends	read close
close Deprecated Description Streetname Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the TechProcess platform for cross-border merchants. 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. Depends on: Required for cross-border merchants.
zip	string	no depends no depends depends	read close
close Deprecated Description Zip code Depends on: Required by the GlobalCollect platform for Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the TechProcess platform for cross-border merchants. Depends on: Required for Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Depends on: Required for cross-border merchants.
vatNumber	string (17)	no	read close
close Deprecated: Use companyInformation.vatNumber instead Description Local VAT number of the company
items	array of object	no	read close
close Deprecated: Use shoppingCart.items instead Description Shopping cart data
items	object	no	read close
close Deprecated SDK Object type LineItem
amountOfMoney	object	no depends depends depends yes	read close
close Deprecated Description Object containing amount and ISO currency code attributes Note: make sure you submit the amount and currency code for each line item Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with product 869 (China UnionPay). Required by the GlobalCollect platform for hosted checkout request. Required by the Ogone platform for hosted checkout request, except when hostedCheckoutSpecificInput.validateShoppingCart is false. Required by the TechProcess platform. Depends on: Required for hosted checkout request, except when hostedCheckoutSpecificInput.validateShoppingCart is false. Depends on: Required for payments and hosted checkouts with product 869 (China UnionPay). Required for hosted checkout request. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Deprecated Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Deprecated Description Three-letter ISO currency code representing the currency for the amount
invoiceData	object	no depends depends depends yes	read close
close Deprecated Description Object containing the line items of the invoice or shopping cart. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with product 869 (China UnionPay). Required by the Ogone platform for hosted checkouts with hostedCheckoutSpecificInput.validateShoppingCart is true or not provided. Required by the TechProcess platform. Depends on: Required for hosted checkouts with hostedCheckoutSpecificInput.validateShoppingCart is true or not provided. Depends on: Required for payments and hosted checkouts with product 869 (China UnionPay). SDK Object type LineItemInvoiceData
description	string (116)	depends	read close
close Deprecated Description Shopping cart item description Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly. This property is required for payments and hosted checkouts with product 869 (China UnionPay). Required by the TechProcess platform.
merchantLinenumber	string (5)	no	read close
close Deprecated Description Line number for printed invoice or order of items in the cart Should be a numeric string
merchantPagenumber	string (3)	no	read close
close Deprecated Description Page number for printed invoice Should be a numeric string
nrOfItems	string (4)	depends	read close
close Deprecated Description Quantity of the item Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly.
pricePerItem	integer (12)	depends	read close
close Deprecated Description Price per item Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly.
level3InterchangeInformation	object	no	read close
close Deprecated: Use orderLineDetails instead Description Object containing additional information that when supplied can have a beneficial effect on the discountrates SDK Object type LineItemLevel3InterchangeInformation
discountAmount	integer (12)	no	read close
close Deprecated Description Discount on the line item, with the last two digits are implied decimal places
lineAmountTotal	integer (12)	no	read close
close Deprecated Description Total amount for the line item
productCode	string (12)	no	read close
close Deprecated Description Product or UPC Code, left justified Note: Must not be all spaces or all zeros
productPrice	integer (12)	no	read close
close Deprecated Description The price of one unit of the product, the value should be zero or greater
productType	string (12)	no	read close
close Deprecated Description Code used to classify items that are purchased Note: Must not be all spaces or all zeros
quantity	integer (4)	no	read close
close Deprecated Description Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros
taxAmount	integer (12)	no	read close
close Deprecated Description Tax on the line item, with the last two digits are implied decimal places
unit	string (12)	no	read close
close Deprecated Description Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
orderLineDetails	object	no depends no depends yes	read close
close Deprecated Description Object containing additional information that when supplied can have a beneficial effect on the discountrates Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). SDK Object type OrderLineDetails
discountAmount	integer (12)	no	read close
close Deprecated Description Discount on the line item, with the last two digits implied as decimal places
googleProductCategoryId	integer (10)	no	read close
close Deprecated Description The Google product category ID for the item.
lineAmountTotal	integer (12)	depends	read close
close Deprecated Description Total amount for the line item Depends on: This property is required for payments and hosted checkouts with product 869 (China UnionPay).
naicsCommodityCode	string (6)	no	read close
close Deprecated Description The UNSPC commodity code of the item.
productCategory	string (50)	no	read close
close Deprecated Description The category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
productCode	string (12)	yes depends depends depends yes	read close
close Deprecated Description Product or UPC Code, left justified Note: Must not be all spaces or all zeros Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for this property is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for this property is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
productName	string (120)	no depends no depends yes	read close
close Deprecated Description The name of the product. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
productPrice	integer (12)	yes depends depends depends depends	read close
close Deprecated Description The price of one unit of the product, the value should be zero or greater Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform for crobss-border merchants. Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for crobss-border merchants.
productSku	string (12)	no	read close
close Deprecated Description Product SKU number
productType	string (12)	depends	read close
close Deprecated Description Code used to classify items that are purchased Note: Must not be all spaces or all zeros Depends on: This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). For the product 869(China UnionPay) this property's value should be one of the following: goods - (default) ticket hotel studyabroad transport
quantity	integer (4)	yes depends depends depends depends	read close
close Deprecated Description Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform for cross-border merchants. Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
taxAmount	integer (12)	no	read close
close Deprecated Description Tax on the line item, with the last two digits implied as decimal places
unit	string (12)	no	read close
close Deprecated Description Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
references	object	depends	read close
close Description Object that holds all reference properties that are linked to this transaction Depends on: This object is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). SDK Object type OrderReferences
descriptor	string (256)	no	read close
close Description Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer: AIB - 22 characters American Express - 25 characters Atos Origin BNP - 15 characters Barclays - 25 characters Catella - 22 characters CBA - 20 characters Elavon - 25 characters First Data - 25 characters INICIS (INIPAY) - 22-30 characters JCB - 25 characters Merchant Solutions - 22-25 characters Payvision (EU & HK) - 25 characters SEB Euroline - 22 characters Sub1 Argentina - 15 characters Wells Fargo - 25 characters Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays For alternative payment products the maximum allowed length varies per payment product: 402 e-Przelewy - 30 characters 404 INICIS - 80 characters 802 Nordea ePayment Finland - 234 characters 809 iDeal - 32 characters 836 SOFORT - 42 characters 840 PayPal - 127 characters 841 WebMoney - 175 characters 849 Yandex - 64 characters 861 Alipay - 256 characters 863 WeChat Pay - 32 characters 880 BOKU - 20 characters 8580 Qiwi - 255 characters 1504 Konbini - 80 characters All other payment products don't support a descriptor.
invoiceData	object	no	read close
close Description Object containing additional invoice data SDK Object type OrderInvoiceData
additionalData	string (500)	no	read close
close Description Additional data for printed invoices
invoiceDate	string (14)	no	read close
close Description Date and time on invoice Format: YYYYMMDDHH24MISS
invoiceNumber	string (20)	no	read close
close Description Your invoice number (on printed invoice) that is also returned in our report files
textQualifiers	array	no	read close
close Description Array of 3 text qualifiers, each with a max length of 10 characters
merchantOrderId	integer (10)	no	read close
close Description Your order identifier Note: This does not need to have a unique value for each transaction. This allows your to link multiple transactions to the same logical order in your system.
merchantReference	string	no depends no depends yes	read close
close Description Note that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. Note that the maximum length of this field for transactions processed on the WL Online Payment Acceptance Platform platform is 50. Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
providerId	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
providerMerchantId	string	no	read close
close Description Provides an additional means of reconciliation, this is the MerchantId used at the provider
seller	object	no	read close
close Deprecated: Use merchant.seller instead Description Object containing seller details SDK Object type Seller
address	object	no	read close
close Deprecated Description Object containing the seller address details SDK Object type Address
additionalInfo	string (50)	no	read close
close Deprecated 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 depends no depends depends	read close
close Deprecated Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Deprecated Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Deprecated 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 depends no no depends	read close
close Deprecated Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Deprecated 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 depends no depends depends	read close
close Deprecated Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Deprecated Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. 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). Depends on: Required for cross-border merchants.
channelCode	string (3)	no	read close
close Deprecated Description This property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.
description	string (32)	no	read close
close Deprecated Description Description of the seller
externalReferenceId	string (15)	no	read close
close Deprecated Description Seller ID assigned by the Merchant Aggregator
geocode	string (5)	no	read close
close Deprecated Description The sellers geocode
id	string (40)	no depends no yes no	read close
close Deprecated Description The sellers identifier Depends on: Required by the GlobalCollect platform.
invoiceNumber	string (12)	no	read close
close Deprecated Description Invoice number of the payment
isForeignRetailer	boolean	no	read close
close Deprecated Description Indicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values: true - The retailer is considered foreign because they are located in a different country than the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the marketplace is within the EEA and UK (and Gibraltar), but the retailer is located outside of the EEA and UK (and Gibraltar) false - The retailer is considered domestic because they are located in the same country as the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the retailer is also located within the EEA and UK (and Gibraltar).
mcc	string (5)	no	read close
close Deprecated Description Merchant category code
name	string (128)	no depends no yes no	read close
close Deprecated Description Name of the seller Depends on: Required by the GlobalCollect platform.
phoneNumber	string (32)	no	read close
close Deprecated Description Main Phone Number
type	string	no depends no yes no	read close
close Deprecated Description Seller type. Possible values: passport dni arg-identity-card civic-notebook enrollment-book cuil cuit general-register election-title cpf cnpj ssn citizen-ship col-identity-card alien-registration Depends on: Required by the GlobalCollect platform.
shipping	object	no depends no no depends	read close
close Description Object containing information regarding shipping / delivery Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants. SDK Object type Shipping
address	object	no depends no no depends	read close
close Description Object containing address information Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants. SDK Object type AddressPersonal
additionalInfo	string (50)	no	read close
close Description Additional address information
city	string	no depends no no depends	read close
close Description City Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no no depends	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
houseNumber	string (15)	no	read close
close Description House number
name	object	no depends no no depends	read close
close Description Object that holds the name elements Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants. SDK Object type PersonalName
firstName	string (15)	depends depends no depends depends	read close
close Description Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for payments.
surname	string (70)	depends depends depends depends depends	read close
close Description Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Required by the Ogone platform for the creation of a Payout. Required by the TechProcess platform for the creation of a payment. Depends on: Required for the creation of a Payout. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for the creation of a payment.
surnamePrefix	string (15)	no	read close
close Description Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
title	string (35)	depends	read close
close Description Title of customer Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
state	string (35)	no depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
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)
street	string (50)	no depends no depends depends	read close
close Description Streetname Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the TechProcess platform for cross-border merchants. 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. Depends on: Required for cross-border merchants.
zip	string	no depends no depends depends	read close
close Description Zip code Depends on: Required by the GlobalCollect platform for Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the TechProcess platform for cross-border merchants. Depends on: Required for Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Depends on: Required for cross-border merchants.
addressIndicator	string	no	read close
close Description Indicates shipping method chosen for the transaction. Possible values: same-as-billing = the shipping address is the same as the billing address another-verified-address-on-file-with-merchant = the address used for shipping is another verified address of the customer that is on file with you different-than-billing = shipping address is different from the billing address ship-to-store = goods are shipped to a store (shipping address = store address) digital-goods = electronic delivery of digital goods travel-and-event-tickets-not-shipped = travel and/or event tickets that are not shipped other = other means of delivery
comments	string (160)	no	read close
close Description Comments included during shipping
emailAddress	string (70)	no depends no no depends	read close
close Description Email address linked to the shipping Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
firstUsageDate	string (8)	no	read close
close Description Date (YYYYMMDD) when the shipping details for this transaction were first used.
isFirstUsage	boolean	no	read close
close Description Indicator if this shipping address is used for the first time to ship an order true = the shipping details are used for the first time with this transaction false = the shipping details have been used for other transactions in the past
shippedFromZip	string (10)	no	read close
close Description The zip/postal code of the location from which the goods were shipped.
trackingNumber	string (19)	no	read close
close Description Shipment tracking number
type	string	no	read close
close Description Indicates the merchandise delivery timeframe. Possible values: electronic = For electronic delivery (services or digital goods) same-day = For same day deliveries overnight = For overnight deliveries 2-day-or-more = For two day or more delivery time for payments that are processed by the GlobalCollect platform 2-day-or-more = For two day or more delivery time for payments that are processed by the Ogone platform priority = For prioritized deliveries for payments that are processed by the WL Online Payment Acceptance platform ground = For deliveries via ground for payments that are processed by the WL Online Payment Acceptance platform to-store = For deliveries to a store for payments that are processed by the WL Online Payment Acceptance platform
shoppingCart	object	no depends no depends yes	read close
close Description Shopping cart data, including items and specific amounts. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). SDK Object type ShoppingCart
amountBreakdown	array of object	no	read close
close Description Determines the type of the amount.
items	object	no	read close
close SDK Object type AmountBreakdown
amount	integer	yes	read close
close Description Amount in cents and always having 2 decimals
type	enum	yes	read close
close Description Type of the amount. Each type is only allowed to be provided once. Allowed values: AIRPORT_TAX - The amount of tax paid for the airport, with the last 2 digits implied as decimal places. CONSUMPTION_TAX - The amount of consumption tax paid by the customer, with the last 2 digits implied as decimal places. DISCOUNT - Discount on the entire transaction, with the last 2 digits implied as decimal places. DUTY - Duty on the entire transaction, with the last 2 digits implied as decimal places. HANDLING - Handling cost on the entire transaction, with the last 2 digits implied as decimal places. SHIPPING - Shipping cost on the entire transaction, with the last 2 digits implied as decimal places. TAX - Total tax paid on the entire transaction, with the last 2 digits implied as decimal places. VAT - Total amount of VAT paid on the transaction, with the last 2 digits implied as decimal places. BASE_AMOUNT - Order amount excluding all taxes, discount & shipping costs, with the last 2 digits implied as decimal places. Note: BASE_AMOUNT is only supported by the GlobalCollect and Ogone Payment Platforms.
giftCardPurchase	object	no	read close
close Description Object containing information on purchased gift card(s) SDK Object type GiftCardPurchase
amountOfMoney	object	no	read close
close Description Object containing information on an amount of money SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
numberOfGiftCards	integer (2)	no	read close
close Description Number of gift cards that are purchased through this transaction
isPreOrder	boolean	no	read close
close Description The customer is pre-ordering one or more items
items	array of object	no depends depends depends yes	read close
close Description Shopping cart data Depends on: Required by the GlobalCollect platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
items	object	no	read close
close SDK Object type LineItem
amountOfMoney	object	no depends depends depends yes	read close
close Description Object containing amount and ISO currency code attributes Note: make sure you submit the amount and currency code for each line item Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with product 869 (China UnionPay). Required by the GlobalCollect platform for hosted checkout request. Required by the Ogone platform for hosted checkout request, except when hostedCheckoutSpecificInput.validateShoppingCart is false. Required by the TechProcess platform. Depends on: Required for hosted checkout request, except when hostedCheckoutSpecificInput.validateShoppingCart is false. Depends on: Required for payments and hosted checkouts with product 869 (China UnionPay). Required for hosted checkout request. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
invoiceData	object	no depends depends depends yes	read close
close Description Object containing the line items of the invoice or shopping cart. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with product 869 (China UnionPay). Required by the Ogone platform for hosted checkouts with hostedCheckoutSpecificInput.validateShoppingCart is true or not provided. Required by the TechProcess platform. Depends on: Required for hosted checkouts with hostedCheckoutSpecificInput.validateShoppingCart is true or not provided. Depends on: Required for payments and hosted checkouts with product 869 (China UnionPay). SDK Object type LineItemInvoiceData
description	string (116)	depends	read close
close Description Shopping cart item description Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly. This property is required for payments and hosted checkouts with product 869 (China UnionPay). Required by the TechProcess platform.
merchantLinenumber	string (5)	no	read close
close Description Line number for printed invoice or order of items in the cart Should be a numeric string
merchantPagenumber	string (3)	no	read close
close Description Page number for printed invoice Should be a numeric string
nrOfItems	string (4)	depends	read close
close Description Quantity of the item Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly.
pricePerItem	integer (12)	depends	read close
close Description Price per item Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly.
level3InterchangeInformation	object	no	read close
close Deprecated: Use orderLineDetails instead Description Object containing additional information that when supplied can have a beneficial effect on the discountrates SDK Object type LineItemLevel3InterchangeInformation
discountAmount	integer (12)	no	read close
close Deprecated Description Discount on the line item, with the last two digits are implied decimal places
lineAmountTotal	integer (12)	no	read close
close Deprecated Description Total amount for the line item
productCode	string (12)	no	read close
close Deprecated Description Product or UPC Code, left justified Note: Must not be all spaces or all zeros
productPrice	integer (12)	no	read close
close Deprecated Description The price of one unit of the product, the value should be zero or greater
productType	string (12)	no	read close
close Deprecated Description Code used to classify items that are purchased Note: Must not be all spaces or all zeros
quantity	integer (4)	no	read close
close Deprecated Description Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros
taxAmount	integer (12)	no	read close
close Deprecated Description Tax on the line item, with the last two digits are implied decimal places
unit	string (12)	no	read close
close Deprecated Description Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
orderLineDetails	object	no depends no depends yes	read close
close Description Object containing additional information that when supplied can have a beneficial effect on the discountrates Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). SDK Object type OrderLineDetails
discountAmount	integer (12)	no	read close
close Description Discount on the line item, with the last two digits implied as decimal places
googleProductCategoryId	integer (10)	no	read close
close Description The Google product category ID for the item.
lineAmountTotal	integer (12)	depends	read close
close Description Total amount for the line item Depends on: This property is required for payments and hosted checkouts with product 869 (China UnionPay).
naicsCommodityCode	string (6)	no	read close
close Description The UNSPC commodity code of the item.
productCategory	string (50)	no	read close
close Description The category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
productCode	string (12)	yes depends depends depends yes	read close
close Description Product or UPC Code, left justified Note: Must not be all spaces or all zeros Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for this property is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for this property is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
productName	string (120)	no depends no depends yes	read close
close Description The name of the product. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
productPrice	integer (12)	yes depends depends depends depends	read close
close Description The price of one unit of the product, the value should be zero or greater Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform for crobss-border merchants. Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for crobss-border merchants.
productSku	string (12)	no	read close
close Description Product SKU number
productType	string (12)	depends	read close
close Description Code used to classify items that are purchased Note: Must not be all spaces or all zeros Depends on: This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). For the product 869(China UnionPay) this property's value should be one of the following: goods - (default) ticket hotel studyabroad transport
quantity	integer (4)	yes depends depends depends depends	read close
close Description Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform for cross-border merchants. Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
taxAmount	integer (12)	no	read close
close Description Tax on the line item, with the last two digits implied as decimal places
unit	string (12)	no	read close
close Description Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
preOrderItemAvailabilityDate	string (8)	no	read close
close Description Date (YYYYMMDD) when the preordered item becomes available
reOrderIndicator	boolean	no	read close
close Description Indicates whether the cardholder is reordering previously purchased item(s) true = the customer is re-ordering at least one of the items again false = this is the first time the customer is ordering these items

Request example

SDK: Ruby

This scenario you will probably use the most

card = Domain::CardWithoutCvv.new
card.card_number = '67030000000000003'
card.cardholder_name = 'Wile E. Coyote'
card.expiry_date = '1299'

card_payment_method_specific_input = Domain::CompletePaymentCardPaymentMethodSpecificInput.new
card_payment_method_specific_input.card = card

body = Domain::CompletePaymentRequest.new
body.card_payment_method_specific_input = card_payment_method_specific_input

response = client.v1.merchant('merchantId').payments.complete('paymentId', body)

Responses

Please find below an overview of the possible responses.

Response 200 - OKCompletePaymentResponse

The complete request was processed successfully. The status of the payment can be found in the response.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
creationOutput	object	no	read close
close Description Object containing the details of the created payment SDK Object type PaymentCreationOutput
additionalReference	string	no	read close
close Description The additional reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
externalReference	string	no	read close
close Description The external reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
isCheckedRememberMe	boolean	no	read close
close Description Indicates whether the customer ticked the "Remember my details for future purchases" checkbox on the MyCheckout hosted payment pages
isNewToken	boolean	no	read close
close Description Indicates if a new token was created true - A new token was created false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to update data stored in the token explicitly, as data is never updated during the creation of a token.
token	string	no	read close
close Description ID of the token
tokenizationSucceeded	boolean	no	read close
close Description Indicates if tokenization was successful or not. If this value is false, then the token and isNewToken properties will not be set.
merchantAction	object	no	read close
close Description Object that contains the action, including the needed data, that you should perform next, like showing instructions, showing the transaction results or redirect to a third party to complete the payment SDK Object type MerchantAction
actionType	enum	no	read close
close Description Action merchants needs to take in the online payment process. Possible values are: REDIRECT - The customer needs to be redirected using the details found in redirectData SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request. Additionally: for payment product 3012 (Bancontact), to support payments via the Bancontact app, showData contains a QR code and URL intent. for payment product 863 (WeChat Pay), to support payments via the WeChat app, showData contains a QR code, URL intent, or signature and nonce combination. The showData property describes when each of these values can be returned. Note that WeChat Pay does not support completing payments. SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object. INITIALIZE_INAPP_THREED_SECURE_SDK - You need to initialize the 3D in app SDK using the returned parameters. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as an initializationParameters object. CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData
formFields	array of object	no	read close
close Description Populated only when the actionType of the merchantAction is SHOW_FORM. In this case, this property contains the list of fields to render, in the format that is also used in the response of Get payment product.
items	object	no	read close
close SDK Object type PaymentProductField
dataRestrictions	object	no	read close
close Description Object containing data restrictions that apply to this field, like minimum and/or maximum length SDK Object type PaymentProductFieldDataRestrictions
isRequired	boolean	no	read close
close Description true - Indicates that this field is required false - Indicates that this field is optional
validators	object	no	read close
close Description Object containing the details of the validations on the field SDK Object type PaymentProductFieldValidators
boletoBancarioRequiredness	object	no	read close
close Description Indicates the requiredness of the field based on the fiscalnumber for Boleto Bancario SDK Object type BoletoBancarioRequirednessValidator
fiscalNumberLength	integer	no	read close
close Description When performing a payment with Boleto Bancario, some values are only required when the fiscalnumber has a specific length. The length the fiscalnumber has to have to make the field required is defined here. For example the CompanyName is required when the fiscalnumber is a CNPJ. The firstname and surname are required when the fiscalnumber is a CPF.
emailAddress	object	no	read close
close Description Indicates that the content should be validated against the rules for an email address SDK Object type EmptyValidator
expirationDate	object	no	read close
close Description Indicates that the content should be validated against the rules for an expiration date (it should be in the future) SDK Object type EmptyValidator
fixedList	object	no	read close
close Description Indicates that content should be one of the, in this object, listed items SDK Object type FixedListValidator
allowedValues	array	no	read close
close Description List of the allowed values that the field will be validated against
iban	object	no	read close
close Description Indicates that the content of this (iban) field needs to validated against format checks and modulo check (as described in ISO 7064) SDK Object type EmptyValidator
length	object	no	read close
close Description Indicates that the content needs to be validated against length criteria defined in this object SDK Object type LengthValidator
maxLength	integer	no	read close
close Description The maximum allowed length
minLength	integer	no	read close
close Description The minimum allowed length
luhn	object	no	read close
close Description Indicates that the content needs to be validated using a LUHN check SDK Object type EmptyValidator
range	object	no	read close
close Description Indicates that the content needs to be validated against a, in this object, defined range SDK Object type RangeValidator
maxValue	integer	no	read close
close Description Upper value of the range that is still valid
minValue	integer	no	read close
close Description Lower value of the range that is still valid
regularExpression	object	no	read close
close Description A string representing the regular expression to check SDK Object type RegularExpressionValidator
regularExpression	string	no	read close
close Description Contains the regular expression that the value of the field needs to be validated against
residentIdNumber	object	no	read close
close Description Indicates that the content needs to be validated as per the Chinese resident identity number format SDK Object type EmptyValidator
termsAndConditions	object	no	read close
close Description Indicates that the content should be validated as such that the customer has accepted the field as if they were terms and conditions of a service SDK Object type EmptyValidator
displayHints	object	no	read close
close Description Object containing display hints for this field, like the order, mask, preferred keyboard SDK Object type PaymentProductFieldDisplayHints
alwaysShow	boolean	no	read close
close Description true - Indicates that this field is advised to be captured to increase the success rates even though it isn't marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer. false - Indicates that this field is not to be shown unless it is a required field.
displayOrder	integer	no	read close
close Description The order in which the fields should be shown (ascending)
formElement	object	no	read close
close Description Object detailing the type of form element that should be used to present the field SDK Object type PaymentProductFieldFormElement
type	string	no	read close
close Description Type of form element to be used. The following types can be returned: text - A normal text input field list - A list of values that the customer needs to choose from, is detailed in the valueMapping array currency - Currency fields should be split into two fields, with the second one being specifically for the cents boolean - Boolean fields should offer the customer a choice, like accepting the terms and conditions of a product. date - let the customer pick a date.
valueMapping	array of object	no	read close
close Description An array of values and displayNames that should be used to populate the list object in the GUI
items	object	no	read close
close SDK Object type ValueMappingElement
displayElements	array of object	no	read close
close Description List of extra data of the value.
items	object	no	read close
close SDK Object type PaymentProductFieldDisplayElement
id	string	no	read close
close Description The ID of the display element.
label	string	no	read close
close Description The label of the display element.
type	enum	no	read close
close Description The type of the display element. Indicates how the value should be presented. Possible values are: STRING - as plain text CURRENCY - as an amount in cents displayed with a decimal separator and the currency of the payment PERCENTAGE - as a number with a percentage sign INTEGER - as an integer URI - as a link
value	string	no	read close
close Description the value of the display element.
displayName	string	no	read close
close Deprecated: Use displayElements instead with ID 'displayName' Description Key name
value	string	no	read close
close Description Value corresponding to the key
label	string	no	read close
close Description Label/Name of the field to be used in the user interface
link	string	no	read close
close Description Link that should be used to replace the '{link}' variable in the label.
mask	string	no	read close
close Description A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters to be ignored during typing). * is used for wildcards (and also chars) 9 is used for numbers Everything outside {{ and }} is used as-is.
obfuscate	boolean	no	read close
close Description true - The data in this field should be obfuscated as it is entered, just like a password field false - The data in this field does not need to be obfuscated
placeholderLabel	string	no	read close
close Description A placeholder value for the form element
preferredInputType	string	no	read close
close Description The type of keyboard that can best be used to fill out the value of this field. Possible values are: PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers StringKeyboard - Keyboard that is used to enter strings IntegerKeyboard - Keyboard that is used to enter only numerical values EmailAddressKeyboard - Keyboard that allows easier entry of email addresses
tooltip	object	no	read close
close Description Object that contains an optional tooltip to assist the customer SDK Object type PaymentProductFieldTooltip
image	string	no	read close
close Description Relative URL that can be used to retrieve an image for the tooltip image. You can use our server-side resize functionality by appending '?size={{width}}x{{height}}' to the full URL, where width and height are specified in pixels. The resized image will always keep its correct aspect ratio.
label	string	no	read close
close Description A text explaining the field in more detail. This is meant to be used for displaying to the customer.
id	string	no	read close
close Description The ID of the field
type	enum	no	read close
close Description The type of field, possible values are: string - Any UTF-8 chracters numericstring - A string that consisting only of numbers. Note that you should strip out anything that is not a digit, but leading zeros are allowed date - Date in the format DDMMYYYY expirydate - Expiration date in the format MMYY integer - An integer boolean - A boolean
usedForLookup	boolean	no	read close
close Description Indicates that the product can be used in a get customer details call and that when that call is done the field should be supplied as (one of the) key(s) with a valid value.
mobileThreeDSecureChallengeParameters	object	no	read close
close Description Populated only when the actionType of the merchantAction is MOBILE_THREEDS_CHALLENGE. In this case, this object contains the list of properties to provide to the EMVco certified Mobile SDK as a challengeParameters object. SDK Object type MobileThreeDSecureChallengeParameters
acsReferenceNumber	string	no	read close
close Description The unique identifier assigned by the EMVCo Secretariat upon testing and approval.
acsSignedContent	string	no	read close
close Description Contains the JWS object created by the ACS for the challenge (ARes).
acsTransactionId	string	no	read close
close Description The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer).
threeDServerTransactionId	string	no	read close
close Description The 3-D Secure version 2 transaction ID that is used for the 3D Authentication
redirectData	object	no	read close
close Description Object containing all data needed to redirect the customer SDK Object type RedirectData
RETURNMAC	string	no	read close
close Description A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
redirectURL	string	no	read close
close Description The URL that the customer should be redirected to. Be sure to redirect using the GET method.
renderingData	string	no	read close
close Description This property contains the blob with data for the instructions rendering service. This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}} This instructions page rendering service accepts the following parameters: instructionsRenderingData (required, the content of this property) locale (optional, if present overrides default locale, e.g. "en_GB") variant (optional, code of a variant, if present overrides default variant, e.g. "100") customerId (required for Pix, otherwise optional, the customerId from a client session) You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call. The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.
showData	array of object	no	read close
close Description This is returned for the SHOW_INSTRUCTION, the SHOW_TRANSACTION_RESULTS and the SHOW_FORM actionType. When returned for SHOW_TRANSACTION_RESULTS or SHOW_FORM, this contains an array of key value pairs of data that needs to be shown to the customer. Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending 'data:image/gif;base64,' this value can be used as the source of an HTML inline image. For SHOW_FORM, for payment product 3012 (Bancontact), this contains a QR code and a URL intent that can be used to complete the payment in the Bancontact app. In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by an Android device with the Bancontact app). The key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on an Android device. For SHOW_FORM, for payment product 863 (WeChat Pay), this contains the PaymentId that WeChat has assigned to the payment. In this case, the key WECHAT_PAYMENTID contains this PaymentId. In addition, this can contain different values depending on the integration type: desktopQRCode - contains a QR code that can be used to complete the payment in the WeChat app. In this case, the key QRCODE contains a base64 encoded PNG image. By prepending 'data:image/png;base64,' this value can be used as the source of an HTML inline image on a desktop or tablet (intended to be scanned by a mobile device with the WeChat app). urlIntent - contains a URL intent that can be used to complete the payment in the WeChat app. In this case, the key URLINTENT contains a URL intent that can be used as the link of an 'open the app' button on a mobile device. For SHOW_FORM, for payment product 740 (PromptPay), this contains a QR code image URL and a timestamp with the expiration date-time of the QR code. In this case, the key QRCODE_IMAGE_URL contains a URL that can be used as the source of an HTML inline image on a desktop. For tablets and mobile devices, it is advised to use the <a> download attribute, so the user can download the image on their device and upload it in their banking mobile application. The key COUNTDOWN_DATETIME, contains a date-time that the QR code will expire. The date-time is in UTC with format: YYYYMMDDHH24MISS. You are advised to show a countdown timer.
items	object	no	read close
close SDK Object type KeyValuePair
key	string	no	read close
close Description Name of the key or property
value	string	no	read close
close Description Value of the key or property
thirdPartyData	object	no	read close
close Description This is returned for the CALL_THIRD_PARTY actionType. The payment product specific field of the payment product used for the payment will be populated with the third party data that should be used when calling the third party. SDK Object type ThirdPartyData
paymentProduct863	object	no	read close
close Description Contains the third party data for payment product 863 (WeChat Pay). SDK Object type PaymentProduct863ThirdPartyData
appId	string	no	read close
close Description The appId to use in third party calls to WeChat.
nonceStr	string	no	read close
close Description The nonceStr to use in third party calls to WeChat
packageSign	string	no	read close
close Description The packageSign to use in third party calls to WeChat
paySign	string	no	read close
close Description The paySign to use in third party calls to WeChat
prepayId	string	no	read close
close Description The prepayId to use in third party calls to WeChat.
signType	string	no	read close
close Description The signType to use in third party calls to WeChat
timeStamp	string	no	read close
close Description The timeStamp to use in third party calls to WeChat
payment	object	no	read close
close Description Object that holds the payment related properties SDK Object type Payment
hostedCheckoutSpecificOutput	object	no	read close
close Description Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout. SDK Object type HostedCheckoutSpecificOutput
hostedCheckoutId	string	no	read close
close Description The ID of the Hosted Checkout Session in which the payment was made.
variant	string	no	read close
close Description Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your hosted mandate pages in a controlled manner. Please note that you need to specify the ID of the variant.
id	string	no	read close
close Description Our unique payment transaction identifier.
paymentOutput	object	no	read close
close Description Object containing payment details SDK Object type PaymentOutput
amountOfMoney	object	no	read close
close Description Object containing amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
amountPaid	integer	no	read close
close Description Amount that has been paid
amountReversed	integer	no	read close
close Description Amount that has been reversed
Group bankTransferPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the bank transfer payment method details SDK Object type BankTransferPaymentMethodSpecificOutput 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.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Group cardPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the card payment method details SDK Object type CardPaymentMethodSpecificOutput 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.
authorisationCode	string	no	read close
close Description Card Authorization code as returned by the acquirer
card	object	no	read close
close Description Object containing card details SDK Object type CardEssentials
cardNumber	string (19)	no	read close
close Description The complete credit/debit card number
cardholderName	string (51)	no	read close
close Description The card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
expiryDate	string (4)	no	read close
close Description Expiry date of the card Format: MMYY
fraudResults	object	no	read close
close Description Fraud results contained in the CardFraudResults object SDK Object type CardFraudResults
avsResult	string	no	read close
close Description Result of the Address Verification Service checks. Possible values are: A - Address (Street) matches, Zip does not B - Street address match for international transactions—Postal code not verified due to incompatible formats C - Street address and postal code not verified for international transaction due to incompatible formats D - Street address and postal code match for international transaction, cardholder name is incorrect E - AVS error F - Address does match and five digit ZIP code does match (UK only) G - Address information is unavailable; international transaction; non-AVS participant H - Billing address and postal code match, cardholder name is incorrect (Amex) I - Address information not verified for international transaction K - Cardholder name matches (Amex) L - Cardholder name and postal code match (Amex) M - Cardholder name, street address, and postal code match for international transaction N - No Match on Address (Street) or Zip O - Cardholder name and address match (Amex) P - Postal codes match for international transaction—Street address not verified due to incompatible formats Q - Billing address matches, cardholder is incorrect (Amex) R - Retry, System unavailable or Timed out S - Service not supported by issuer U - Address information is unavailable W - 9 digit Zip matches, Address (Street) does not X - Exact AVS Match Y - Address (Street) and 5 digit Zip match Z - 5 digit Zip matches, Address (Street) does not 0 - No service available
cvvResult	string	no	read close
close Description Result of the Card Verification Value checks. Possible values are: M - CVV check performed and valid value N - CVV checked and no match P - CVV check not performed, not requested S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card U - Issuer not certified for CVV2 Y - Server provider did not respond 0 - No service available
fraudServiceResult	string	no	read close
close Description Resulting advice of the fraud prevention checks. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted an error. Note that the fraud check was thus not performed.
fraugster	object	no	read close
close Description Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent. SDK Object type FraugsterResults
fraudInvestigationPoints	string	no	read close
close Description Result of the Fraugster check Contains the investigation points used during the evaluation
fraudScore	integer	no	read close
close Description Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
retailDecisions	object	no	read close
close Description Additional response data returned by RetailDecisions SDK Object type FraudResultsRetailDecisions
fraudCode	string	no	read close
close Description Result of the fraud service. Provides additional information about the fraud result
fraudNeural	string	no	read close
close Description Returns the raw score of the neural
fraudRCF	string	no	read close
close Description Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
initialSchemeTransactionId	string	no	read close
close Description The unique scheme transactionId of the initial transaction that was performed with SCA. Should be stored by the merchant to allow it to be submitted in future transactions.
networkTokenUsed	boolean	no	read close
close Description Indicates if a network token was used during the payment.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
schemeTransactionId	string	no	read close
close Description The unique scheme transactionId of this transaction. Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty.
threeDSecureResults	object	no	read close
close Description 3D Secure results object SDK Object type ThreeDSecureResults
acsTransactionId	string	no	read close
close Description Identifier of the authenticated transaction at the ACS/Issuer
appliedExemption	string	no	read close
close Description Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
authenticationAmount	object	no	read close
close Description The amount for which this transaction has been authenticated. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
cavv	string	no	read close
close Description CAVV or AVV result indicating authentication validation value
directoryServerTransactionId	string	no	read close
close Description The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
eci	string	no	read close
close Description Indicates Authentication validation results returned after AuthenticationValidation
exemptionOutput	object	no	read close
close Description Object containing exemption output SDK Object type ExemptionOutput
exemptionRaised	string	no	read close
close Description Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
exemptionRejectionReason	string	no	read close
close Description The request exemption could not be granted. The reason why is returned in this property.
exemptionRequest	string	no	read close
close Description Type of strong customer authentication (SCA) exemption requested by you for this transaction.
schemeRiskScore	integer	no	read close
close Description Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
sdkData	object	no	read close
close Description Object containing 3-D Secure in-app SDK data SDK Object type SdkDataOutput
sdkTransactionId	string	no	read close
close Description Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
threeDSecureData	object	no	read close
close Description Object containing data regarding the 3-D Secure authentication SDK Object type ThreeDSecureData
acsTransactionId	string (36)	no	read close
close Description The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
method	string	no	read close
close Description Method of authentication used for this transaction. Possible values: frictionless = The authentication went without a challenge challenged = Cardholder was challenged avs-verified = The authentication was verified by AVS other = Another issuer method was used to authenticate this transaction
utcTimestamp	string (12)	no	read close
close Description Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
threeDSecureVersion	string	no	read close
close Description The 3-D Secure version used for the authentication. This property is used in the communication with the acquirer
threeDServerTransactionId	string	no	read close
close Description The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
xid	string	no	read close
close Description Transaction ID for the Authentication
token	string	no	read close
close Description If a token was used for or created during the payment, then the ID of that token.
Group cashPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the cash payment method details SDK Object type CashPaymentMethodSpecificOutput 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.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Group directDebitPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the non SEPA direct debit payment method details SDK Object type NonSepaDirectDebitPaymentMethodSpecificOutput 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.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Group eInvoicePaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the e-invoice payment method details SDK Object type EInvoicePaymentMethodSpecificOutput 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.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProduct9000SpecificOutput	object	yes	read close
close Description AfterPay Installments (payment product 9000) specific details SDK Object type EInvoicePaymentProduct9000SpecificOutput
installmentId	string	yes	read close
close Description The ID of the installment plan used for the payment.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Group invoicePaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the invoice payment method details SDK Object type InvoicePaymentMethodSpecificOutput 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.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Group mobilePaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the mobile payment method details SDK Object type MobilePaymentMethodSpecificOutput 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.
authorisationCode	string	no	read close
close Description Card Authorization code as returned by the acquirer
fraudResults	object	no	read close
close Description Fraud results contained in the CardFraudResults object SDK Object type CardFraudResults
avsResult	string	no	read close
close Description Result of the Address Verification Service checks. Possible values are: A - Address (Street) matches, Zip does not B - Street address match for international transactions—Postal code not verified due to incompatible formats C - Street address and postal code not verified for international transaction due to incompatible formats D - Street address and postal code match for international transaction, cardholder name is incorrect E - AVS error F - Address does match and five digit ZIP code does match (UK only) G - Address information is unavailable; international transaction; non-AVS participant H - Billing address and postal code match, cardholder name is incorrect (Amex) I - Address information not verified for international transaction K - Cardholder name matches (Amex) L - Cardholder name and postal code match (Amex) M - Cardholder name, street address, and postal code match for international transaction N - No Match on Address (Street) or Zip O - Cardholder name and address match (Amex) P - Postal codes match for international transaction—Street address not verified due to incompatible formats Q - Billing address matches, cardholder is incorrect (Amex) R - Retry, System unavailable or Timed out S - Service not supported by issuer U - Address information is unavailable W - 9 digit Zip matches, Address (Street) does not X - Exact AVS Match Y - Address (Street) and 5 digit Zip match Z - 5 digit Zip matches, Address (Street) does not 0 - No service available
cvvResult	string	no	read close
close Description Result of the Card Verification Value checks. Possible values are: M - CVV check performed and valid value N - CVV checked and no match P - CVV check not performed, not requested S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card U - Issuer not certified for CVV2 Y - Server provider did not respond 0 - No service available
fraudServiceResult	string	no	read close
close Description Resulting advice of the fraud prevention checks. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted an error. Note that the fraud check was thus not performed.
fraugster	object	no	read close
close Description Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent. SDK Object type FraugsterResults
fraudInvestigationPoints	string	no	read close
close Description Result of the Fraugster check Contains the investigation points used during the evaluation
fraudScore	integer	no	read close
close Description Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
retailDecisions	object	no	read close
close Description Additional response data returned by RetailDecisions SDK Object type FraudResultsRetailDecisions
fraudCode	string	no	read close
close Description Result of the fraud service. Provides additional information about the fraud result
fraudNeural	string	no	read close
close Description Returns the raw score of the neural
fraudRCF	string	no	read close
close Description Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
network	string	no	read close
close Description The network that was used for the refund
paymentData	object	no	read close
close Description Object containing payment details SDK Object type MobilePaymentData
dpan	string (19)	yes	read close
close Description The obfuscated DPAN. Only the last four digits are visible.
expiryDate	string (4)	yes	read close
close Description Expiry date of the tokenized card Format: MMYY
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
threeDSecureResults	object	no	read close
close Description 3D Secure results object SDK Object type ThreeDSecureResults
acsTransactionId	string	no	read close
close Description Identifier of the authenticated transaction at the ACS/Issuer
appliedExemption	string	no	read close
close Description Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
authenticationAmount	object	no	read close
close Description The amount for which this transaction has been authenticated. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
cavv	string	no	read close
close Description CAVV or AVV result indicating authentication validation value
directoryServerTransactionId	string	no	read close
close Description The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
eci	string	no	read close
close Description Indicates Authentication validation results returned after AuthenticationValidation
exemptionOutput	object	no	read close
close Description Object containing exemption output SDK Object type ExemptionOutput
exemptionRaised	string	no	read close
close Description Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
exemptionRejectionReason	string	no	read close
close Description The request exemption could not be granted. The reason why is returned in this property.
exemptionRequest	string	no	read close
close Description Type of strong customer authentication (SCA) exemption requested by you for this transaction.
schemeRiskScore	integer	no	read close
close Description Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
sdkData	object	no	read close
close Description Object containing 3-D Secure in-app SDK data SDK Object type SdkDataOutput
sdkTransactionId	string	no	read close
close Description Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
threeDSecureData	object	no	read close
close Description Object containing data regarding the 3-D Secure authentication SDK Object type ThreeDSecureData
acsTransactionId	string (36)	no	read close
close Description The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
method	string	no	read close
close Description Method of authentication used for this transaction. Possible values: frictionless = The authentication went without a challenge challenged = Cardholder was challenged avs-verified = The authentication was verified by AVS other = Another issuer method was used to authenticate this transaction
utcTimestamp	string (12)	no	read close
close Description Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
threeDSecureVersion	string	no	read close
close Description The 3-D Secure version used for the authentication. This property is used in the communication with the acquirer
threeDServerTransactionId	string	no	read close
close Description The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
xid	string	no	read close
close Description Transaction ID for the Authentication
Group redirectPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the redirect payment product details SDK Object type RedirectPaymentMethodSpecificOutput 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	no	read close
close Description Object that holds the Basic Bank Account Number (BBAN) data 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.
bankAccountIban	object	no	read close
close Description Object containing account holder name and IBAN information 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
bic	string	no	read close
close Description The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
Group paymentProduct3201SpecificOutput	object	no	read close
close Description PostFinance Card (payment product 3201) specific details SDK Object type PaymentProduct3201SpecificOutput 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.
card	object	no	read close
close Description Object containing card details SDK Object type CardEssentials
cardNumber	string (19)	no	read close
close Description The complete credit/debit card number
cardholderName	string (51)	no	read close
close Description The card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
expiryDate	string (4)	no	read close
close Description Expiry date of the card Format: MMYY
Group paymentProduct806SpecificOutput	object	no	read close
close Description Trustly (payment product 806) specific details SDK Object type PaymentProduct806SpecificOutput 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.
billingAddress	object	no	read close
close Description Object containing the billing address details of the customer 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 depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess 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 depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
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 depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends 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 payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. 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). Depends on: Required for cross-border merchants.
customerAccount	object	no	read close
close Description Object containing the account details SDK Object type TrustlyBankAccount
accountLastDigits	string	no	read close
close Description The last digits of the account number
bankName	string	no	read close
close Description The name of the bank
clearinghouse	string	no	read close
close Description The country of the clearing house
personIdentificationNumber	string	no	read close
close Description The ID number of the account holder
Group paymentProduct836SpecificOutput	object	no	read close
close Description Sofort (payment product 836) specific details SDK Object type PaymentProduct836SpecificOutput 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.
securityIndicator	string	no	read close
close Description Indicates if SofortBank could estabilish if the transaction could successfully be processed. 0 - You should wait for the transaction to be reported as paid before shipping any goods. 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.
Group paymentProduct840SpecificOutput	object	no	read close
close Description PayPal (payment product 840) specific details SDK Object type PaymentProduct840SpecificOutput 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.
billingAddress	object	no	read close
close Description Object containing the billing address details of the customer 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 depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess 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 depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
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 depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends 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 payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. 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). Depends on: Required for cross-border merchants.
customerAccount	object	no	read close
close Description Object containing the details of the PayPal account SDK Object type PaymentProduct840CustomerAccount
accountId	string	no	read close
close Description Username with which the PayPal account holder has registered at PayPal
billingAgreementId	string	no	read close
close Description Identification of the PayPal recurring billing agreement
companyName	string	no	read close
close Description Name of the company in case the PayPal account is owned by a business
contactPhone	string	no	read close
close Description The phone number of the PayPal account holder
countryCode	string	no	read close
close Description Country where the PayPal account is located
customerAccountStatus	string	no	read close
close Description Status of the PayPal account. Possible values are: verified - PayPal has verified the funding means for this account unverified - PayPal has not verified the funding means for this account
customerAddressStatus	string	no	read close
close Description Status of the customer's shipping address as registered by PayPal Possible values are: none - Status is unknown at PayPal confirmed - The address has been confirmed unconfirmed - The address has not been confirmed
firstName	string	no	read close
close Description First name of the PayPal account holder
payerId	string	no	read close
close Description The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
surname	string	no	read close
close Description Surname of the PayPal account holder
customerAddress	object	no	read close
close Description Object containing the address details of the customer 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 depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess 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 depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
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 depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. 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 payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends 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 payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. 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). Depends on: Required for cross-border merchants.
protectionEligibility	object	no	read close
close Description Protection Eligibility data of the PayPal customer SDK Object type ProtectionEligibility
eligibility	string	no	read close
close Description Possible values: Eligible PartiallyEligible Ineligible
type	string	no	read close
close Description Possible values: ItemNotReceivedEligible UnauthorizedPaymentEligible Ineligible
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
token	string	no	read close
close Description ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
Group sepaDirectDebitPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the SEPA direct debit details SDK Object type SepaDirectDebitPaymentMethodSpecificOutput 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.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProduct771SpecificOutput	object	yes	read close
close Description Output that is SEPA Direct Debit specific (i.e. the used mandate) SDK Object type PaymentProduct771SpecificOutput
mandateReference	string	no	read close
close Description Unique reference to a Mandate
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
token	string	no	read close
close Description ID of the token. This property is populated for the GlobalCollect payment platform when the payment was done with a token or when the payment was tokenized.
paymentMethod	string	no	read close
close Description Payment method identifier used by the our payment engine with the following possible values: bankRefund bankTransfer card cash directDebit eInvoice invoice redirect
references	object	no	read close
close Description Object that holds all reference properties that are linked to this transaction SDK Object type PaymentReferences
merchantOrderId	integer	no	read close
close Description Your order ID for this transaction that is also returned in our report files
merchantReference	string	no	read close
close Description Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
paymentReference	string	no	read close
close Description Payment Reference generated by WebCollect
providerId	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
providerMerchantId	string	no	read close
close Description Provides an additional means of reconciliation, this is the MerchantId used at the provider
providerReference	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
referenceOrigPayment	string	no	read close
close Description When you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
reversalReason	string	no	read close
close Description The reason description given for the reversedAmount property.
status	enum	no	read close
close Description Current high-level status of the payment in a human-readable form. Possible values are : ACCOUNT_VERIFIED - The account has been verified using a validation services like 0$ auth CREATED - The transaction has been created. This is the initial state once a new payment is created. REDIRECTED - The customer has been redirected to a 3rd party to complete the authentication/payment PENDING_PAYMENT - Instructions have been provided and we are now waiting for the money to come in PENDING_FRAUD_APPROVAL - The transaction has been marked for manual review after an automatic fraud screening PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the capturing of the funds PENDING_COMPLETION - The transaction needs to be completed. PENDING_CAPTURE - The transaction is waiting for you to request one or more captures of the funds. REJECTED - The transaction has been rejected AUTHORIZATION_REQUESTED - we have requested an authorization against an asynchronous system and is awaiting its response CAPTURE_REQUESTED - The transaction is in the queue to be captured CAPTURED - The transaction has been captured and we have received online confirmation PAID - We have matched the incoming funds to the transaction CANCELLED - You have cancelled the transaction REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request REVERSED - The transaction has been reversed CHARGEBACK_NOTIFICATION - We have received a notification of chargeback and this status informs you that your account will be debited for a particular transaction CHARGEBACKED - The transaction has been chargebacked REFUNDED - The transaction has been refunded Please see Statuses for a full overview of possible values.
statusOutput	object	no	read close
close Description This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed. SDK Object type PaymentStatusOutput
errors	array of object	no	read close
close Description Custom object contains the set of 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
isAuthorized	boolean	no	read close
close Description Indicates if the transaction has been authorized true false
isCancellable	boolean	no	read close
close Description Flag indicating if the payment can be cancelled true false
isRefundable	boolean	no	read close
close Description Flag indicating if the payment can be refunded true false
isRetriable	boolean	no	read close
close Description Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee true false
providerRawOutput	array of object	no	read close
close Description This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
items	object	no	read close
close SDK Object type KeyValuePair
key	string	no	read close
close Description Name of the key or property
value	string	no	read close
close Description Value of the key or property
statusCategory	enum	no	read close
close Description Highlevel status of the payment, payout or refund with the following possible values: CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses: CREATED PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses: PENDING_PAYMENT REDIRECTED ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses: ACCOUNT_VERIFIED PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses: PENDING_APPROVAL PENDING_COMPLETION PENDING_CAPTURE PENDING_FRAUD_APPROVAL PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses: AUTHORIZATION_REQUESTED CAPTURE_REQUESTED PAYOUT_REQUESTED REFUND_REQUESTED COMPLETED: The transaction has completed. This category groups the following statuses: CAPTURED PAID ACCOUNT_CREDITED CHARGEBACK_NOTIFICATION REVERSED: The transaction has been reversed. This category groups the following statuses: CHARGEBACKED REVERSED REFUNDED: The transaction has been refunded. This category groups the following statuses: REFUNDED UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses: CANCELLED REJECTED REJECTED_CAPTURE REJECTED_CREDIT Please see Statuses for a full overview of possible values.
statusCode	integer	no	read close
close Description Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
statusCodeChangeDateTime	string	no	read close
close Description Date and time of payment Format: YYYYMMDDHH24MISS
threeDSecureStatus	enum	no	read close
close Description The 3D Secure status, with the following possible values: ENROLLED: the card is enrolled for 3D Secure authentication. The customer can be redirected to a 3D Secure access control server (ACS) NOT_ENROLLED: the card is not enrolled for 3D Secure authentication INVALID_PARES_OR_NOT_COMPLETED: the PARes is invalid, or the customer did not complete the 3D Secure authentication AUTHENTICATED: the customer has passed the 3D Secure authentication NOT_AUTHENTICATED: the customer failed the 3D Secure authentication NOT_PARTICIPATING: the cardholder has not set up their card for 2-step 3D Secure. Note that this status will only be set for payments that make use of 2-step 3D Secure.

Response example

SDK: Ruby

This scenario you will probably use the most

{
    "creationOutput" : {
        "isNewToken" : true,
        "token" : "36ccec55-ecf5-42a3-b384-f08bdb05d952",
        "tokenizationSucceeded" : true
    },
    "merchantAction" : {
        "actionType" : "REDIRECT",
        "redirectData" : {
            "RETURNMAC" : "ac8fa7e3-c1d2-4154-90bc-7ca2a8fc50e2",
            "redirectURL" : "https://pay1.checkout.worldline-solutions.com/redirector/8342e656-2d00-40bd-bdf7-20cf2848decc"
        }
    },
    "payment" : {
        "id" : "2712689_0",
        "paymentOutput" : {
            "amountOfMoney" : {
                "amount" : 290081,
                "currencyCode" : "EUR"
            },
            "references" : {
                "merchantReference" : "2254b457-b8e3-4fb7-96d0-dbb28c7921c1"
            },
            "paymentMethod" : "card",
            "cardPaymentMethodSpecificOutput" : {
                "paymentProductId" : 3012,
                "card" : {
                    "cardNumber" : "670300-XXXXXXXX-03",
                    "expiryDate" : "1299"
                },
                "threeDSecureResults" : {
                    "authenticationAmount" : {
                        "currencyCode" : "EUR",
                        "amount" : 290081
                    }
                }
            }
        },
        "status" : "REDIRECTED",
        "statusOutput" : {
            "isCancellable" : false,
            "statusCategory" : "PENDING_PAYMENT",
            "statusCode" : 0,
            "isAuthorized" : false,
            "isRefundable" : false
        }
    }
}

Response 400 - Bad requestErrorResponse

The given payment was not completable.

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: Ruby

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

Complete payment

Payments

Request

PayloadCompletePaymentRequest

Description

Depends on:

Description

Description

Depends on:

Description

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Depends on:

Depends on:

Depends on:

Description

Depends on:

Description

Depends on:

Description

Depends on:

Depends on:

Description

Depends on:

Description

Depends on:

Depends on:

Depends on:

Depends on:

Description

Depends on:

Depends on:

Depends on:

Depends on:

Description

Description

Description

Description

Description

Depends on:

Description

Description

Description

Description

Depends on:

Description

Description

Depends on:

Description

Depends on:

Description

Description

Depends on:

Depends on:

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Description

Depends on:

Depends on:

Depends on:

Depends on:

Description

Depends on:

Description

Depends on: