Complete payment
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
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
object | depends | read close | |
close
DescriptionObject containing the specific input details for card payments
Depends on:Required to complete a Bancontact (3012) payment
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
|
|||
close
DescriptionExpiry date of the card
Format: MMYY Depends on:Required for Create and Update token.
|
|||
close
DescriptionIssue number on the card (if applicable)
|
|||
object | no | read close | |
close
DescriptionIn 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.
|
|||
close
DescriptionURL to find contact or support details to contact in case of questions.
|
|||
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. 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. |
|||
close
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the GlobalCollect platform.
Required by the TechProcess platform. |
|||
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
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). |
|||
close
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
|
|||
close
DescriptionStreetname
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. |
|||
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. 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. |
|||
close
DescriptionThis property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.
|
|||
close
DescriptionDescription of the seller
|
|||
close
DescriptionSeller ID assigned by the Merchant Aggregator
|
|||
close
DescriptionThe sellers geocode
|
|||
close
DescriptionThe sellers identifier
Depends on:Required by the GlobalCollect platform.
|
|||
close
DescriptionInvoice number of the payment
|
|||
close
DescriptionIndicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values:
|
|||
close
DescriptionMerchant category code
|
|||
close
DescriptionName of the seller
Depends on:Required by the GlobalCollect platform.
|
|||
close
DescriptionMain Phone Number
|
|||
close
DescriptionSeller type. Possible values:
Depends on:Required by the GlobalCollect platform.
|
|||
close
DescriptionThe 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.
|
|||
object | no | read close | |
close
DescriptionObject 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.
|
|||
close
DescriptionObject 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.
|
|||
close
DescriptionShould 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.
|
|||
close
DescriptionDefines the account number type of the recipient. Possible values are:
Depends on:Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995 when order.additionalInput.accountFundingRecipient.accountNumber is provided.
|
|||
close
DescriptionObject containing the address details of the recipient of an account funding transaction.
|
|||
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. 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. |
|||
close
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the GlobalCollect platform.
Required by the TechProcess platform. |
|||
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
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). |
|||
close
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
|
|||
close
DescriptionStreetname
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. |
|||
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. 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. |
|||
close
DescriptionThe 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.
|
|||
close
DescriptionObject 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.
|
|||
close
DescriptionGiven name(s) or first name(s) of the recipient of an account funding transaction.
|
|||
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
close
DescriptionEither 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.
|
|||
close
DescriptionObject 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.
|
|||
close
DescriptionNumeric code identifying the agent
|
|||
close
DescriptionAirline numeric code
|
|||
close
DescriptionDate of the Flight
Format: YYYYMMDD Depends on:Required by the TechProcess platform for airline merchants.
|
|||
close
DescriptionObject that holds the data on the individual legs of the ticket
Depends on:Required by the TechProcess platform for airline merchants.
|
|||
close
DescriptionReservation Booking Designator
|
|||
close
DescriptionArrival airport/city code
Depends on:Required by the TechProcess platform for airline merchants.
|
|||
close
DescriptionThe arrival time in the local time zone
Format: HH:MM |
|||
close
DescriptionIATA carrier code
|
|||
close
DescriptionIdentifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
|
|||
close
DescriptionThe 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
|
|||
close
DescriptionDate of the leg
Format: YYYYMMDD Depends on:Required by the TechProcess platform for airline merchants.
|
|||
close
DescriptionThe departure time in the local time at the departure airport
Format: HH:MM Depends on:Required for PayPal (840) when Airline data is submitted
|
|||
close
DescriptionAn 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
|
|||
close
DescriptionNew ticket number that is issued when a ticket is exchanged
|
|||
close
DescriptionFare of this leg
|
|||
close
DescriptionFare Basis/Ticket Designator
|
|||
close
DescriptionFee for this leg of the trip
|
|||
close
DescriptionThe 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
|
|||
close
DescriptionSequence number of the flight leg
|
|||
close
DescriptionOrigin airport/city code
Depends on:Required by the TechProcess platform for airline merchants.
|
|||
close
DescriptionPassengerClass if this leg
|
|||
close
Deprecated:
Use passengerClass instead
DescriptionServiceClass of this leg (this property is used for fraud screening on the Ogone Payment Platform).
Possible values are:
|
|||
close
DescriptionPossible values are:
Depends on:Required for PayPal (840) when Airline data is submitted
|
|||
close
DescriptionTaxes for this leg of the trip
|
|||
close
DescriptionAirline tracing number
|
|||
close
Description
|
|||
close
Deprecated:
Use order.customer.accountType instead
Description
|
|||
close
Description
|
|||
close
Description
|
|||
close
DescriptionThis 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 |
|||
close
DescriptionYour ID of the customer in the context of the airline data
|
|||
close
DescriptionName of the airline
|
|||
close
DescriptionTotal 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.
|
|||
close
DescriptionName of passenger
Depends on:Required by the TechProcess platform for airline merchants.
|
|||
close
DescriptionObject that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
|
|||
close
DescriptionFirst name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
close
DescriptionSurname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
close
DescriptionSurname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
close
DescriptionTitle of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
close
DescriptionPlace of issue
For sales in the US the last two characters (pos 14-15) must be the US state code. |
|||
close
DescriptionPassenger name record
Depends on:Required by the TechProcess platform for airline merchants.
|
|||
close
DescriptionIATA point of sale name
|
|||
close
Descriptioncity code of the point of sale
|
|||
close
DescriptionPossible values:
|
|||
close
DescriptionThe ticket or document number. On the Ogone Payment Platform and the GlobalCollect Payment Platform it contains:
|
|||
close
DescriptionTotal fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets
|
|||
close
DescriptionTotal fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
|
|||
close
DescriptionTotal taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
|
|||
close
DescriptionName of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.
|
|||
close
DescriptionObject 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionObject containing the total amount and ISO currency code attributes
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionThe frequency in which the installments will be collected from the customer.
The possible values are:
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. |
|||
close
DescriptionThe code for the installment plan. The possible values are:
|
|||
close
DescriptionThe 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. |
|||
close
DescriptionThe 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.
|
|||
close
Deprecated:
Use order.shoppingCart.amountBreakdown instead
DescriptionObject that holds Level3 summary data
|
|||
close
Deprecated:
Use order.shoppingCart.amountBreakdown with type DISCOUNT instead
DescriptionDiscount on the entire transaction, with the last 2 digits are implied decimal places
|
|||
close
Deprecated:
Use order.shoppingCart.amountBreakdown with type DUTY instead
DescriptionDuty on the entire transaction, with the last 2 digits are implied decimal places
|
|||
close
Deprecated:
Use order.shoppingCart.amountBreakdown with type SHIPPING instead
DescriptionShippingcost on the entire transaction, with the last 2 digits are implied decimal places
|
|||
close
Deprecated:
No replacement
DescriptionObject 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.
|
|||
close
Deprecated:
No replacement
DescriptionShould 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.
|
|||
close
Deprecated:
No replacement
DescriptionThe 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.
|
|||
close
Deprecated:
No replacement
DescriptionShould 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.
|
|||
close
Deprecated:
No replacement
DescriptionSurname of the recipient of the loan.
Depends on:Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
|
|||
close
Deprecated:
No replacement
DescriptionZip code of the recipient of the loan
Depends on:Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
|
|||
close
DescriptionObject that holds lodging related charges
|
|||
close
DescriptionAmount of additional charges associated with the stay of the guest.
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode. |
|||
close
DescriptionCurrency for Charge amount. The code should be in 3 letter ISO format.
|
|||
close
DescriptionType of additional charges associated with the stay of the guest.
Allowed values:
|
|||
close
DescriptionThe date the guest checks into (or plans to check in to) the facility.
Format: YYYYMMDD |
|||
close
DescriptionThe date the guest checks out of (or plans to check out of) the facility.
Format: YYYYMMDD |
|||
close
DescriptionThe 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.
|
|||
close
DescriptionIndicates whether the room reservation is confirmed.
|
|||
close
DescriptionDefines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation.
|
|||
close
DescriptionIndicate if this the customer is a no show case. In such case, the lodging property can charge a no show fee.
|
|||
close
DescriptionIndicated the preference of the customer for a smoking or non-smoking room.
|
|||
close
DescriptionThe total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)
|
|||
close
DescriptionThe number of nights for the lodging stay
|
|||
close
DescriptionThe number of rooms rented for the lodging stay
|
|||
close
DescriptionCode that corresponds to the category of lodging charges detailed in this message.
Allowed values:
|
|||
close
DescriptionThe international customer service phone number of the facility
|
|||
close
DescriptionThe local phone number of the facility in an international phone number format
|
|||
close
DescriptionName of the person or business entity charged for the reservation and/or lodging stay
|
|||
close
DescriptionObject that holds lodging related room data
|
|||
close
DescriptionDaily room rate exclusive of any taxes and fees
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode. |
|||
close
DescriptionCurrency for Daily room rate. The code should be in 3 letter ISO format
|
|||
close
DescriptionDaily room tax
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode. |
|||
close
DescriptionCurrency for Daily room tax. The code should be in 3 letter ISO format
|
|||
close
DescriptionNumber of nights charged at the rate in the dailyRoomRate property
|
|||
close
DescriptionLocation of the room within the facility, e.g. Park or Garden etc.
|
|||
close
DescriptionRoom number
|
|||
close
DescriptionSize of bed, e.g., king, queen, double.
|
|||
close
DescriptionDescribes the type of room, e.g., standard, deluxe, suite.
|
|||
close
Deprecated:
Use installments.numberOfInstallments instead.
DescriptionThe 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.
|
|||
close
DescriptionDate and time of order
Format: YYYYMMDDHH24MISS |
|||
close
DescriptionObject that holds the purchase and usage type indicators
|
|||
close
DescriptionIdentifies the funding type being authenticated. Possible values are:
Depends on:Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995.
|
|||
close
DescriptionPayment code to support account funding transactions. Possible values are:
|
|||
close
DescriptionPossible values are:
|
|||
close
DescriptionIdentifies the type of transaction being authenticated.
Possible values are:
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.
|
|||
close
DescriptionPossible values are:
|
|||
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionObject 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.
|
|||
close
DescriptionObject containing data related to the account the customer has with you
|
|||
close
DescriptionObject containing data on the authentication used by the customer to access their account
|
|||
close
DescriptionData 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:
|
|||
close
DescriptionAuthentication used by the customer on your website or app
Possible values :
Depends on:Required when order.customer.account.authentication.data is provided.
|
|||
close
DescriptionTimestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
|
|||
close
DescriptionThe 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.
|
|||
close
Descriptiontrue = 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. |
|||
close
DescriptionThe date (YYYYMMDD) on which the customer created their account with you
|
|||
close
DescriptionSpecifies 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 |
|||
close
DescriptionSpecifies if the customer (initially) had forgotten their password
|
|||
close
DescriptionSpecifies if the customer entered a password to gain access to an account registered with the you
|
|||
close
DescriptionThe last date (YYYYMMDD) on which the customer changed their password for the account used in this transaction
|
|||
close
DescriptionIndicates 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 |
|||
close
DescriptionObject containing information on the payment account data on file (tokens)
|
|||
close
DescriptionThe 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. |
|||
close
DescriptionNumber of attempts made to add new card to the customer account in the last 24 hours
|
|||
close
DescriptionIndicates the type of account. For example, for a multi-account card product.
Depends on:Required for merchants in Brazil
|
|||
close
DescriptionObject containing data on the purchase history of the customer with you
|
|||
close
DescriptionNumber of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours
|
|||
close
DescriptionNumber of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months
|
|||
close
DescriptionNumber of successful purchases made by this customer with you in the last 6 months
|
|||
close
DescriptionType of the customer account that is used to place this order. Can have one of the following values:
|
|||
close
DescriptionObject 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.
|
|||
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. 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. |
|||
close
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the GlobalCollect platform.
Required by the TechProcess platform. |
|||
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
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). |
|||
close
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
|
|||
close
DescriptionStreetname
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. |
|||
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. 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. |
|||
close
DescriptionObject containing company information
Depends on:Required by the WOPA platform for payments when the property order.customer.fiscalNumber is set to:
Required by the TechProcess platform for cross-border payments when the property order.customer.isCompany is set to true.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionName of company, as a customer
Depends on:Required by the WOPA platform for payments when the property order.customer.fiscalNumber is set to:
|
|||
close
DescriptionLocal 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:
|
|||
close
DescriptionObject containing contact details like email address and phone number
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.
|
|||
close
DescriptionEmail address of the customer. 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 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:
One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser":
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. |
|||
close
DescriptionPreference for the type of email message markup
|
|||
close
DescriptionFax number of the customer
|
|||
close
DescriptionInternational version of the mobile phone number of the customer including the leading + (i.e. +16127779311).
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:
One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser":
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. |
|||
close
DescriptionPhone number of the customer. 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 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:
One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser":
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. |
|||
close
DescriptionInternational 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":
|
|||
close
DescriptionObject containing information on the device and browser of the customer
Depends on:Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser".
Required by the TechProcess platform for payments.
|
|||
close
DescriptionThe accept-header of the customer client from the HTTP Headers.
Depends on:Required for 3-D Secure version 2 for the authenticationFlow "browser"
|
|||
close
DescriptionObject containing information regarding the browser of the customer
Depends on:Required by the WOPA platform for Required for 3-D Secure version 2 for the browser flow.
|
|||
close
DescriptionColorDepth 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"
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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.
|
|||
close
Descriptiontrue =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"
|
|||
close
Descriptiontrue = 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"
|
|||
close
DescriptionHeight 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"
|
|||
close
DescriptionWidth 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"
|
|||
close
DescriptionDegree of default form fill, with the following possible values:
|
|||
close
DescriptionOne must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
|
|||
close
DescriptionThe IP address of the customer client from the HTTP Headers.
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". |
|||
close
DescriptionLocale 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 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". |
|||
close
DescriptionOffset 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 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". |
|||
close
DescriptionUser-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 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". |
|||
close
DescriptionThe 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:
Depends on:Required for payments done with payment products:
Required for cross-border TechProcess merchants. |
|||
close
DescriptionIndicates if the payer is a company or an individual
|
|||
close
DescriptionSpecifies if the customer has a history of online shopping with the merchant
|
|||
close
DescriptionThe 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).
|
|||
close
DescriptionYour identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
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. |
|||
close
DescriptionObject containing personal information like name, date of birth and gender.
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.
|
|||
close
DescriptionThe 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:
Required by the TechProcess platform for cross-border payments when the property order.customer.isCompany is set to false. |
|||
close
DescriptionThe gender of the customer, possible values are:
|
|||
close
DescriptionObject 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:
|
|||
close
DescriptionISO 3166-1 alpha-2 country code of the country that issued the identification document
|
|||
close
DescriptionIndicates the type of identification
|
|||
close
DescriptionThe value of the identification
|
|||
close
DescriptionObject containing the name details of the customer
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.
|
|||
close
DescriptionGiven 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 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. |
|||
close
DescriptionSurname(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 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. |
|||
close
DescriptionMiddle 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.
|
|||
close
DescriptionTitle 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).
|
|||
close
Deprecated:
Use order.shipping.address instead
DescriptionObject containing shipping address details
|
|||
close
Deprecated
DescriptionAdditional address information
|
|||
close
Deprecated
DescriptionCity
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
Deprecated
DescriptionHouse number
|
|||
close
Deprecated
DescriptionObject that holds the name elements
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
Deprecated
DescriptionGiven 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 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. |
|||
close
Deprecated
DescriptionSurname(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 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. |
|||
close
Deprecated
DescriptionMiddle 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.
|
|||
close
Deprecated
DescriptionTitle 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).
|
|||
close
Deprecated
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto)
|
|||
close
Deprecated
DescriptionStreetname
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. |
|||
close
Deprecated
DescriptionZip 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. |
|||
close
Deprecated:
Use companyInformation.vatNumber instead
DescriptionLocal VAT number of the company
|
|||
close
Deprecated:
Use shoppingCart.items instead
DescriptionShopping cart data
|
|||
close
Deprecated
DescriptionObject 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.
|
|||
close
Deprecated
DescriptionAmount in cents and always having 2 decimals
|
|||
close
Deprecated
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
Deprecated
DescriptionObject 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.
|
|||
close
Deprecated
DescriptionShopping 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. |
|||
close
Deprecated
DescriptionLine number for printed invoice or order of items in the cart
Should be a numeric string |
|||
close
Deprecated
DescriptionPage number for printed invoice
Should be a numeric string |
|||
close
Deprecated
DescriptionQuantity 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.
|
|||
close
Deprecated
DescriptionPrice 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.
|
|||
close
Deprecated:
Use orderLineDetails instead
DescriptionObject containing additional information that when supplied can have a beneficial effect on the discountrates
|
|||
close
Deprecated
DescriptionDiscount on the line item, with the last two digits are implied decimal places
|
|||
close
Deprecated
DescriptionTotal amount for the line item
|
|||
close
Deprecated
DescriptionProduct or UPC Code, left justified
Note: Must not be all spaces or all zeros |
|||
close
Deprecated
DescriptionThe price of one unit of the product, the value should be zero or greater
|
|||
close
Deprecated
DescriptionCode used to classify items that are purchased
Note: Must not be all spaces or all zeros |
|||
close
Deprecated
DescriptionQuantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros |
|||
close
Deprecated
DescriptionTax on the line item, with the last two digits are implied decimal places
|
|||
close
Deprecated
DescriptionIndicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
|
|||
close
Deprecated
DescriptionObject 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.
|
|||
close
Deprecated
DescriptionDiscount on the line item, with the last two digits implied as decimal places
|
|||
close
Deprecated
DescriptionThe Google product category ID for the item.
|
|||
close
Deprecated
DescriptionTotal amount for the line item
Depends on:This property is required for payments and hosted checkouts with product 869 (China UnionPay).
|
|||
close
Deprecated
DescriptionThe UNSPC commodity code of the item.
|
|||
close
Deprecated
DescriptionThe category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
|
|||
close
Deprecated
DescriptionProduct 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. |
|||
close
Deprecated
DescriptionThe 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. |
|||
close
Deprecated
DescriptionThe 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. |
|||
close
Deprecated
DescriptionProduct SKU number
|
|||
close
Deprecated
DescriptionCode 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:
|
|||
close
Deprecated
DescriptionQuantity 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. |
|||
close
Deprecated
DescriptionTax on the line item, with the last two digits implied as decimal places
|
|||
close
Deprecated
DescriptionIndicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
|
|||
close
DescriptionObject 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).
|
|||
close
DescriptionDescriptive 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:
For alternative payment products the maximum allowed length varies per payment product:
|
|||
close
DescriptionAdditional data for printed invoices
|
|||
close
DescriptionDate and time on invoice
Format: YYYYMMDDHH24MISS |
|||
close
DescriptionYour invoice number (on printed invoice) that is also returned in our report files
|
|||
close
DescriptionArray of 3 text qualifiers, each with a max length of 10 characters
|
|||
close
DescriptionYour 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. |
|||
close
DescriptionNote 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. |
|||
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
close
Deprecated:
Use merchant.seller instead
DescriptionObject containing seller details
|
|||
close
Deprecated
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
close
Deprecated
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. 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. |
|||
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the GlobalCollect platform.
Required by the TechProcess platform. |
|||
close
Deprecated
DescriptionHouse 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). |
|||
close
Deprecated
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
|
|||
close
Deprecated
DescriptionStreetname
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. |
|||
close
Deprecated
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. 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. |
|||
close
Deprecated
DescriptionThis property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.
|
|||
close
Deprecated
DescriptionDescription of the seller
|
|||
close
Deprecated
DescriptionSeller ID assigned by the Merchant Aggregator
|
|||
close
Deprecated
DescriptionThe sellers geocode
|
|||
close
Deprecated
DescriptionThe sellers identifier
Depends on:Required by the GlobalCollect platform.
|
|||
close
Deprecated
DescriptionInvoice number of the payment
|
|||
close
Deprecated
DescriptionIndicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values:
|
|||
close
Deprecated
DescriptionMerchant category code
|
|||
close
Deprecated
DescriptionName of the seller
Depends on:Required by the GlobalCollect platform.
|
|||
close
Deprecated
DescriptionMain Phone Number
|
|||
close
Deprecated
DescriptionSeller type. Possible values:
Depends on:Required by the GlobalCollect platform.
|
|||
close
DescriptionObject containing information regarding shipping / delivery
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionObject containing address information
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionAdditional address information
|
|||
close
DescriptionCity
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionHouse number
|
|||
close
DescriptionObject that holds the name elements
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionGiven 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 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. |
|||
close
DescriptionSurname(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 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. |
|||
close
DescriptionMiddle 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.
|
|||
close
DescriptionTitle 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).
|
|||
close
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto)
|
|||
close
DescriptionStreetname
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. |
|||
close
DescriptionZip 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. |
|||
close
DescriptionIndicates shipping method chosen for the transaction. Possible values:
|
|||
close
DescriptionComments included during shipping
|
|||
close
DescriptionEmail address linked to the shipping
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionDate (YYYYMMDD) when the shipping details for this transaction were first used.
|
|||
close
DescriptionIndicator 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 |
|||
close
DescriptionThe zip/postal code of the location from which the goods were shipped.
|
|||
close
DescriptionShipment tracking number
|
|||
close
DescriptionIndicates the merchandise delivery timeframe. Possible values:
|
|||
close
DescriptionShopping 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.
|
|||
close
DescriptionDetermines the type of the amount.
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionType of the amount. Each type is only allowed to be provided once. Allowed values:
|
|||
close
DescriptionObject containing information on purchased gift card(s)
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionNumber of gift cards that are purchased through this transaction
|
|||
close
DescriptionThe customer is pre-ordering one or more items
|
|||
close
DescriptionShopping 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. |
|||
close
DescriptionObject 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.
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionObject 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.
|
|||
close
DescriptionShopping 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. |
|||
close
DescriptionLine number for printed invoice or order of items in the cart
Should be a numeric string |
|||
close
DescriptionPage number for printed invoice
Should be a numeric string |
|||
close
DescriptionQuantity 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.
|
|||
close
DescriptionPrice 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.
|
|||
close
Deprecated:
Use orderLineDetails instead
DescriptionObject containing additional information that when supplied can have a beneficial effect on the discountrates
|
|||
close
Deprecated
DescriptionDiscount on the line item, with the last two digits are implied decimal places
|
|||
close
Deprecated
DescriptionTotal amount for the line item
|
|||
close
Deprecated
DescriptionProduct or UPC Code, left justified
Note: Must not be all spaces or all zeros |
|||
close
Deprecated
DescriptionThe price of one unit of the product, the value should be zero or greater
|
|||
close
Deprecated
DescriptionCode used to classify items that are purchased
Note: Must not be all spaces or all zeros |
|||
close
Deprecated
DescriptionQuantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros |
|||
close
Deprecated
DescriptionTax on the line item, with the last two digits are implied decimal places
|
|||
close
Deprecated
DescriptionIndicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
|
|||
close
DescriptionObject 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.
|
|||
close
DescriptionDiscount on the line item, with the last two digits implied as decimal places
|
|||
close
DescriptionThe Google product category ID for the item.
|
|||
close
DescriptionTotal amount for the line item
Depends on:This property is required for payments and hosted checkouts with product 869 (China UnionPay).
|
|||
close
DescriptionThe UNSPC commodity code of the item.
|
|||
close
DescriptionThe category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
|
|||
close
DescriptionProduct 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. |
|||
close
DescriptionThe 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. |
|||
close
DescriptionThe 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. |
|||
close
DescriptionProduct SKU number
|
|||
close
DescriptionCode 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:
|
|||
close
DescriptionQuantity 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. |
|||
close
DescriptionTax on the line item, with the last two digits implied as decimal places
|
|||
close
DescriptionIndicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
|
|||
close
DescriptionDate (YYYYMMDD) when the preordered item becomes available
|
|||
close
DescriptionIndicates 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 |
|||
Property | Type | Required | Details |
Request example
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.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
object | no | read close | |
close
DescriptionObject containing the details of the created payment
|
|||
close
DescriptionThe additional reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
|
|||
close
DescriptionThe external reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them.
|
|||
close
DescriptionIndicates whether the customer ticked the "Remember my details for future purchases" checkbox on the MyCheckout hosted payment pages
|
|||
close
DescriptionIndicates if a new token was created
|
|||
close
DescriptionID of the token
|
|||
close
DescriptionIndicates if tokenization was successful or not. If this value is false, then the token and isNewToken properties will not be set.
|
|||
object | no | read close | |
close
DescriptionObject 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
|
|||
close
DescriptionAction merchants needs to take in the online payment process. Possible values are:
|
|||
close
DescriptionPopulated 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.
|
|||
close
DescriptionObject containing data restrictions that apply to this field, like minimum and/or maximum length
|
|||
close
Description
|
|||
close
DescriptionObject containing the details of the validations on the field
|
|||
close
DescriptionIndicates the requiredness of the field based on the fiscalnumber for Boleto Bancario
|
|||
close
DescriptionWhen 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.
|
|||
close
DescriptionIndicates that the content should be validated against the rules for an email address
|
|||
close
DescriptionIndicates that the content should be validated against the rules for an expiration date (it should be in the future)
|
|||
close
DescriptionIndicates that content should be one of the, in this object, listed items
|
|||
close
DescriptionList of the allowed values that the field will be validated against
|
|||
close
DescriptionIndicates that the content of this (iban) field needs to validated against format checks and modulo check (as described in ISO 7064)
|
|||
close
DescriptionIndicates that the content needs to be validated against length criteria defined in this object
|
|||
close
DescriptionThe maximum allowed length
|
|||
close
DescriptionThe minimum allowed length
|
|||
close
DescriptionIndicates that the content needs to be validated using a LUHN check
|
|||
close
DescriptionIndicates that the content needs to be validated against a, in this object, defined range
|
|||
close
DescriptionUpper value of the range that is still valid
|
|||
close
DescriptionLower value of the range that is still valid
|
|||
close
DescriptionA string representing the regular expression to check
|
|||
close
DescriptionContains the regular expression that the value of the field needs to be validated against
|
|||
close
DescriptionIndicates that the content needs to be validated as per the Chinese resident identity number format
|
|||
close
DescriptionIndicates 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
|
|||
close
DescriptionObject containing display hints for this field, like the order, mask, preferred keyboard
|
|||
close
Description
|
|||
close
DescriptionThe order in which the fields should be shown (ascending)
|
|||
close
DescriptionObject detailing the type of form element that should be used to present the field
|
|||
close
DescriptionType of form element to be used. The following types can be returned:
|
|||
close
DescriptionAn array of values and displayNames that should be used to populate the list object in the GUI
|
|||
close
DescriptionList of extra data of the value.
|
|||
close
DescriptionThe ID of the display element.
|
|||
close
DescriptionThe label of the display element.
|
|||
close
DescriptionThe type of the display element. Indicates how the value should be presented. Possible values are:
|
|||
close
Descriptionthe value of the display element.
|
|||
close
Deprecated:
Use displayElements instead with ID 'displayName'
DescriptionKey name
|
|||
close
DescriptionValue corresponding to the key
|
|||
close
DescriptionLabel/Name of the field to be used in the user interface
|
|||
close
DescriptionLink that should be used to replace the '{link}' variable in the label.
|
|||
close
DescriptionA 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. |
|||
close
Description
|
|||
close
DescriptionA placeholder value for the form element
|
|||
close
DescriptionThe type of keyboard that can best be used to fill out the value of this field. Possible values are:
|
|||
close
DescriptionObject that contains an optional tooltip to assist the customer
|
|||
close
DescriptionRelative 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.
|
|||
close
DescriptionA text explaining the field in more detail. This is meant to be used for displaying to the customer.
|
|||
close
DescriptionThe ID of the field
|
|||
close
DescriptionThe type of field, possible values are:
|
|||
close
DescriptionIndicates 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.
|
|||
close
DescriptionPopulated 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.
|
|||
close
DescriptionThe unique identifier assigned by the EMVCo Secretariat upon testing and approval.
|
|||
close
DescriptionContains the JWS object created by the ACS for the challenge (ARes).
|
|||
close
DescriptionThe ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer).
|
|||
close
DescriptionThe 3-D Secure version 2 transaction ID that is used for the 3D Authentication
|
|||
close
DescriptionObject containing all data needed to redirect the customer
|
|||
close
DescriptionA Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
|
|||
close
DescriptionThe URL that the customer should be redirected to. Be sure to redirect using the GET method.
|
|||
close
DescriptionThis 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:
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. |
|||
close
DescriptionThis 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:
|
|||
close
DescriptionName of the key or property
|
|||
close
DescriptionValue of the key or property
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionContains the third party data for payment product 863 (WeChat Pay).
|
|||
close
DescriptionThe appId to use in third party calls to WeChat.
|
|||
close
DescriptionThe nonceStr to use in third party calls to WeChat
|
|||
close
DescriptionThe packageSign to use in third party calls to WeChat
|
|||
close
DescriptionThe paySign to use in third party calls to WeChat
|
|||
close
DescriptionThe prepayId to use in third party calls to WeChat.
|
|||
close
DescriptionThe signType to use in third party calls to WeChat
|
|||
close
DescriptionThe timeStamp to use in third party calls to WeChat
|
|||
object | no | read close | |
close
DescriptionHosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout.
|
|||
close
DescriptionThe ID of the Hosted Checkout Session in which the payment was made.
|
|||
close
DescriptionUsing 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.
|
|||
close
DescriptionOur unique payment transaction identifier.
|
|||
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionAmount that has been paid
|
|||
close
DescriptionAmount that has been reversed
|
|||
close
DescriptionObject containing the bank transfer payment method details
|
|||
close
DescriptionThis object contains the results of the Cybersource Decision Manager assessment. Cybersource is a fraud detection tool leveraging data networks, configurable rules, intelligence, and device fingerprinting to identify risky transactions.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionResult of the Cybersource Decision Manager check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
close
DescriptionName of the policy that was applied during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
close
DescriptionThe type of device used by the customer. Example values:
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionResult 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.
|
|||
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThe type of device used by the customer.
|
|||
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
close
DescriptionObject containing the card payment method details
|
|||
close
DescriptionCard Authorization code as returned by the acquirer
|
|||
close
DescriptionThe complete credit/debit card number
|
|||
close
DescriptionThe card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
|
|||
close
DescriptionExpiry date of the card
Format: MMYY |
|||
close
DescriptionFraud results contained in the CardFraudResults object
|
|||
close
DescriptionResult of the Address Verification Service checks. Possible values are:
|
|||
close
DescriptionResult of the Card Verification Value checks. Possible values are:
|
|||
close
DescriptionThis object contains the results of the Cybersource Decision Manager assessment. Cybersource is a fraud detection tool leveraging data networks, configurable rules, intelligence, and device fingerprinting to identify risky transactions.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionResult of the Cybersource Decision Manager check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
close
DescriptionName of the policy that was applied during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionResulting advice of the fraud prevention checks. Possible values are:
|
|||
close
DescriptionResults 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.
|
|||
close
DescriptionResult of the Fraugster check
Contains the investigation points used during the evaluation
|
|||
close
DescriptionResult of the Fraugster check
Contains the overall Fraud score which is an integer between 0 and 99
|
|||
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
close
DescriptionThe type of device used by the customer. Example values:
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionResult 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.
|
|||
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThe type of device used by the customer.
|
|||
close
DescriptionAdditional response data returned by RetailDecisions
|
|||
close
DescriptionResult of the fraud service.
Provides additional information about the fraud result
|
|||
close
DescriptionReturns the raw score of the neural
|
|||
close
DescriptionResult of the fraud service
Represent sets of fraud rules returned during the evaluation of the transaction
|
|||
close
DescriptionThe 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. |
|||
close
DescriptionObject holding data that describes a network token.
|
|||
close
DescriptionThe network token alternative for the full Permanent Account Number. To receive a non-obfuscated network token please contact your account manager.
|
|||
close
DescriptionThe expiry date of the network token.
|
|||
close
DescriptionA unique identifier that can be used with Visa Token Service (VTS) or Mastercard Digital Enablement Service (MDES) to retrieve token details. It remains valid as long as the token is valid. Note: A prefix "V:" is added to show that this is a network token for a Visa product and "M:" to show that this is a network token for a Mastercard product.
|
|||
close
DescriptionIndicates if a network token was used during the payment.
|
|||
close
DescriptionA unique reference to the primary account number. Payment Account Reference provides a consolidated view of transactions associated with a PAN and its affiliated tokens, making it easier to identify customers and their associated transactions across payment channels.
|
|||
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
close
DescriptionThe 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. |
|||
close
DescriptionIdentifier of the authenticated transaction at the ACS/Issuer
|
|||
close
DescriptionExemption code from Carte Bancaire (130) (unknown possible values so far -free format)
|
|||
close
DescriptionThe amount for which this transaction has been authenticated.
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionCAVV or AVV result indicating authentication validation value
|
|||
close
DescriptionThe 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
|
|||
close
DescriptionIndicates Authentication validation results returned after AuthenticationValidation
|
|||
close
DescriptionType of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
|
|||
close
DescriptionThe request exemption could not be granted. The reason why is returned in this property.
|
|||
close
DescriptionType of strong customer authentication (SCA) exemption requested by you for this transaction.
|
|||
close
DescriptionGlobal score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
|
|||
close
DescriptionUniversally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
|
|||
close
DescriptionObject containing data regarding the 3-D Secure authentication
|
|||
close
DescriptionThe ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
|
|||
close
DescriptionMethod of authentication used for this transaction.
Possible values:
|
|||
close
DescriptionTimestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
|
|||
close
DescriptionThe 3-D Secure version used for the authentication.
This property is used in the communication with the acquirer |
|||
close
DescriptionThe 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
|
|||
close
DescriptionTransaction ID for the Authentication
|
|||
close
DescriptionIf a token was used for or created during the payment, then the ID of that token.
|
|||
close
DescriptionObject containing the cash payment method details
|
|||
close
DescriptionThis object contains the results of the Cybersource Decision Manager assessment. Cybersource is a fraud detection tool leveraging data networks, configurable rules, intelligence, and device fingerprinting to identify risky transactions.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionResult of the Cybersource Decision Manager check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
close
DescriptionName of the policy that was applied during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
close
DescriptionThe type of device used by the customer. Example values:
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionResult 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.
|
|||
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThe type of device used by the customer.
|
|||
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
close
DescriptionObject containing the non SEPA direct debit payment method details
|
|||
close
DescriptionThis object contains the results of the Cybersource Decision Manager assessment. Cybersource is a fraud detection tool leveraging data networks, configurable rules, intelligence, and device fingerprinting to identify risky transactions.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionResult of the Cybersource Decision Manager check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
close
DescriptionName of the policy that was applied during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
close
DescriptionThe type of device used by the customer. Example values:
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionResult 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.
|
|||
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThe type of device used by the customer.
|
|||
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
close
DescriptionObject containing the e-invoice payment method details
|
|||
close
DescriptionThis object contains the results of the Cybersource Decision Manager assessment. Cybersource is a fraud detection tool leveraging data networks, configurable rules, intelligence, and device fingerprinting to identify risky transactions.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionResult of the Cybersource Decision Manager check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
close
DescriptionName of the policy that was applied during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
close
DescriptionThe type of device used by the customer. Example values:
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionResult 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.
|
|||
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThe type of device used by the customer.
|
|||
close
DescriptionAfterPay Installments (payment product 9000) specific details
|
|||
close
DescriptionThe ID of the installment plan used for the payment.
|
|||
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
close
DescriptionObject containing the invoice payment method details
|
|||
close
DescriptionThis object contains the results of the Cybersource Decision Manager assessment. Cybersource is a fraud detection tool leveraging data networks, configurable rules, intelligence, and device fingerprinting to identify risky transactions.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionResult of the Cybersource Decision Manager check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
close
DescriptionName of the policy that was applied during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
close
DescriptionThe type of device used by the customer. Example values:
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionResult 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.
|
|||
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThe type of device used by the customer.
|
|||
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
close
DescriptionObject containing the mobile payment method details
|
|||
close
DescriptionCard Authorization code as returned by the acquirer
|
|||
close
DescriptionFraud results contained in the CardFraudResults object
|
|||
close
DescriptionResult of the Address Verification Service checks. Possible values are:
|
|||
close
DescriptionResult of the Card Verification Value checks. Possible values are:
|
|||
close
DescriptionThis object contains the results of the Cybersource Decision Manager assessment. Cybersource is a fraud detection tool leveraging data networks, configurable rules, intelligence, and device fingerprinting to identify risky transactions.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionResult of the Cybersource Decision Manager check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
close
DescriptionName of the policy that was applied during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionResulting advice of the fraud prevention checks. Possible values are:
|
|||
close
DescriptionResults 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.
|
|||
close
DescriptionResult of the Fraugster check
Contains the investigation points used during the evaluation
|
|||
close
DescriptionResult of the Fraugster check
Contains the overall Fraud score which is an integer between 0 and 99
|
|||
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
close
DescriptionThe type of device used by the customer. Example values:
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionResult 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.
|
|||
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThe type of device used by the customer.
|
|||
close
DescriptionAdditional response data returned by RetailDecisions
|
|||
close
DescriptionResult of the fraud service.
Provides additional information about the fraud result
|
|||
close
DescriptionReturns the raw score of the neural
|
|||
close
DescriptionResult of the fraud service
Represent sets of fraud rules returned during the evaluation of the transaction
|
|||
close
DescriptionThe network that was used for the refund
|
|||
close
DescriptionThe obfuscated DPAN. Only the last four digits are visible.
|
|||
close
DescriptionExpiry date of the tokenized card
Format: MMYY |
|||
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
close
DescriptionIdentifier of the authenticated transaction at the ACS/Issuer
|
|||
close
DescriptionExemption code from Carte Bancaire (130) (unknown possible values so far -free format)
|
|||
close
DescriptionThe amount for which this transaction has been authenticated.
|
|||
close
DescriptionAmount in cents and always having 2 decimals
|
|||
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
close
DescriptionCAVV or AVV result indicating authentication validation value
|
|||
close
DescriptionThe 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
|
|||
close
DescriptionIndicates Authentication validation results returned after AuthenticationValidation
|
|||
close
DescriptionType of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
|
|||
close
DescriptionThe request exemption could not be granted. The reason why is returned in this property.
|
|||
close
DescriptionType of strong customer authentication (SCA) exemption requested by you for this transaction.
|
|||
close
DescriptionGlobal score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
|
|||
close
DescriptionUniversally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
|
|||
close
DescriptionObject containing data regarding the 3-D Secure authentication
|
|||
close
DescriptionThe ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
|
|||
close
DescriptionMethod of authentication used for this transaction.
Possible values:
|
|||
close
DescriptionTimestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
|
|||
close
DescriptionThe 3-D Secure version used for the authentication.
This property is used in the communication with the acquirer |
|||
close
DescriptionThe 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
|
|||
close
DescriptionTransaction ID for the Authentication
|
|||
close
DescriptionObject containing the redirect payment product details
|
|||
close
DescriptionObject that holds the Basic Bank Account Number (BBAN) data
|
|||
close
DescriptionName of the account holder
Depends on:Required for Create and Update token calls for ACH (730).
|
|||
close
DescriptionBank 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. |
|||
close
DescriptionBank 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). |
|||
close
DescriptionName of the bank
|
|||
close
DescriptionBranch code
|
|||
close
DescriptionBank check digit
|
|||
close
DescriptionISO 3166-1 alpha-2 country code of the country where the bank account is held
For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
|
|||
close
DescriptionObject containing account holder name and IBAN information
|
|||
close
DescriptionName in which the account is held.
Depends on:Required for the creation of a Payout
Required for Create and Update token calls. |
|||
close
DescriptionThe IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
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 |
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThis object contains the results of the Cybersource Decision Manager assessment. Cybersource is a fraud detection tool leveraging data networks, configurable rules, intelligence, and device fingerprinting to identify risky transactions.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionResult of the Cybersource Decision Manager check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
close
DescriptionName of the policy that was applied during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
close
DescriptionThe type of device used by the customer. Example values:
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionResult 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.
|
|||
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThe type of device used by the customer.
|
|||
close
DescriptionPostFinance Card (payment product 3201) specific details
|
|||
close
DescriptionThe complete credit/debit card number
|
|||
close
DescriptionThe card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
|
|||
close
DescriptionExpiry date of the card
Format: MMYY |
|||
close
DescriptionTrustly (payment product 806) specific details
|
|||
close
DescriptionObject containing the billing address details of the customer
|
|||
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. 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. |
|||
close
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the GlobalCollect platform.
Required by the TechProcess platform. |
|||
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
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). |
|||
close
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
|
|||
close
DescriptionStreetname
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. |
|||
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. 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. |
|||
close
DescriptionThe last digits of the account number
|
|||
close
DescriptionThe name of the bank
|
|||
close
DescriptionThe country of the clearing house
|
|||
close
DescriptionThe ID number of the account holder
|
|||
close
DescriptionSofort (payment product 836) specific details
|
|||
close
DescriptionIndicates if SofortBank could estabilish if the transaction could successfully be processed.
|
|||
close
DescriptionPayPal (payment product 840) specific details
|
|||
close
DescriptionObject containing the billing address details of the customer
|
|||
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. 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. |
|||
close
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the GlobalCollect platform.
Required by the TechProcess platform. |
|||
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
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). |
|||
close
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
|
|||
close
DescriptionStreetname
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. |
|||
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. 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. |
|||
close
DescriptionObject containing the details of the PayPal account
|
|||
close
DescriptionUsername with which the PayPal account holder has registered at PayPal
|
|||
close
DescriptionIdentification of the PayPal recurring billing agreement
|
|||
close
DescriptionName of the company in case the PayPal account is owned by a business
|
|||
close
DescriptionThe phone number of the PayPal account holder
|
|||
close
DescriptionCountry where the PayPal account is located
|
|||
close
DescriptionStatus of the PayPal account.
Possible values are:
|
|||
close
DescriptionStatus of the customer's shipping address as registered by PayPal
Possible values are:
|
|||
close
DescriptionFirst name of the PayPal account holder
|
|||
close
DescriptionThe unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
|
|||
close
DescriptionSurname of the PayPal account holder
|
|||
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. 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. |
|||
close
DescriptionISO 3166-1 alpha-2 country code
Depends on:Required by the GlobalCollect platform.
Required by the TechProcess platform. |
|||
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
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). |
|||
close
DescriptionFull name of the state or province
Depends on:Required by the TechProcess platform for cross-border merchants.
|
|||
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
Depends on:Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
|
|||
close
DescriptionStreetname
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. |
|||
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. 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. |
|||
close
DescriptionProtection Eligibility data of the PayPal customer
|
|||
close
DescriptionPossible values:
|
|||
close
DescriptionPossible values:
|
|||
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
close
DescriptionID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
|
|||
close
DescriptionObject containing the SEPA direct debit details
|
|||
close
DescriptionThis object contains the results of the Cybersource Decision Manager assessment. Cybersource is a fraud detection tool leveraging data networks, configurable rules, intelligence, and device fingerprinting to identify risky transactions.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionResult of the Cybersource Decision Manager check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
close
DescriptionName of the policy that was applied during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
close
DescriptionThe type of device used by the customer. Example values:
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe 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.
|
|||
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionResult 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.
|
|||
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
close
DescriptionList of one or more reason codes.
|
|||
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
close
DescriptionThe type of device used by the customer.
|
|||
close
DescriptionOutput that is SEPA Direct Debit specific (i.e. the used mandate)
|
|||
close
DescriptionUnique reference to a Mandate
|
|||
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
close
DescriptionID 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.
|
|||
close
DescriptionPayment method identifier used by the our payment engine with the following possible values:
|
|||
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
close
DescriptionYour order ID for this transaction that is also returned in our report files
|
|||
close
DescriptionYour 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.
|
|||
close
DescriptionPayment Reference generated by WebCollect
|
|||
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
close
DescriptionWhen 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
|
|||
close
DescriptionThe reason description given for the reversedAmount property.
|
|||
close
DescriptionCurrent high-level status of the payment in a human-readable form. Possible values are :
Please see Statuses for a full overview of possible values. |
|||
close
DescriptionThis 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.
|
|||
close
DescriptionCustom object contains the set of errors
|
|||
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
close
DescriptionError code
|
|||
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
close
DescriptionID of the request that can be used for debugging purposes
|
|||
close
DescriptionIndicates if the transaction has been authorized
|
|||
close
DescriptionFlag indicating if the payment can be cancelled
|
|||
close
DescriptionFlag indicating if the payment can be refunded
|
|||
close
DescriptionFlag indicating whether a rejected payment may be retried by the merchant without incurring a fee
|
|||
close
DescriptionThis 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.
|
|||
close
DescriptionName of the key or property
|
|||
close
DescriptionValue of the key or property
|
|||
close
DescriptionHighlevel status of the payment, payout or refund with the following possible values:
Please see Statuses for a full overview of possible values. |
|||
close
DescriptionNumeric 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.
|
|||
close
DescriptionDate and time of payment
Format: YYYYMMDDHH24MISS |
|||
close
DescriptionThe 3D Secure status, with the following possible values:
|
|||
Property | Type | Required | Details |
Response example
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.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
errorId | string | yes | read close |
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
array of object | yes | read close | |
close
DescriptionList of one or more errors
|
|||
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
close
DescriptionError code
|
|||
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
close
DescriptionID of the request that can be used for debugging purposes
|
|||
Property | Type | Required | Details |
Response example
This scenario you will probably use the most
-
{ "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092", "errors" : [ { "code" : "20000000", "propertyName" : "bankAccountBban.accountNumber", "message" : "PARAMETER_NOT_FOUND_IN_REQUEST" } ] }