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.
Payloaddomain.CompletePaymentRequest
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
object | depends | read close | |
close
DescriptionObject containing the specific input details for card payments
|
|||
object | yes | read close | |
cardNumber | string (19) | depends | read close |
close
DescriptionThe complete credit/debit card number (also know as the PAN). The minimum input length is 12 digits.
|
|||
cardholderName | string (51) | no | read close |
close
DescriptionThe card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
|
|||
expiryDate | string (4) | depends | read close |
close
DescriptionExpiry date of the card
Format: MMYY |
|||
issueNumber | string (2) | no | read close |
close
DescriptionIssue number on the card (if applicable)
|
|||
object | no | read close | |
close
DescriptionObject containing information on you, the merchant
|
|||
configurationId | string | 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.
|
|||
contactWebsiteUrl | string (2048) | no | read close |
close
DescriptionURL to find contact or support details to contact in case of questions.
|
|||
object | no | read close | |
object | no | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends depends no depends depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no depends no no depends | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
channelCode | string (3) | no | read close |
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.
|
|||
description | string (32) | no | read close |
close
DescriptionDescription of the seller
|
|||
externalReferenceId | string (15) | no | read close |
close
DescriptionSeller ID assigned by the Merchant Aggregator
|
|||
geocode | string (5) | no | read close |
close
DescriptionThe sellers geocode
|
|||
id | string (40) | no depends no yes no | read close |
close
DescriptionThe sellers identifier
|
|||
invoiceNumber | string (12) | no | read close |
close
DescriptionInvoice number of the payment
|
|||
isForeignRetailer | boolean | no | read close |
close
DescriptionIndicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values:
|
|||
mcc | string (5) | no | read close |
close
DescriptionMerchant category code
|
|||
name | string (128) | no depends no yes no | read close |
close
DescriptionName of the seller
|
|||
phoneNumber | string (32) | no | read close |
close
DescriptionMain Phone Number
|
|||
type | string | no depends no yes no | read close |
close
DescriptionSeller type. Possible values:
|
|||
websiteUrl | string (60) | no depends no no yes | read close |
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.
|
|||
object | no | read close | |
object | no depends no depends yes | read close | |
close
DescriptionObject containing additional input on the order
|
|||
object | depends | read close | |
close
DescriptionObject containing specific data regarding the recipient of an account funding transaction
|
|||
accountNumber | string (50) | depends | read close |
close
DescriptionShould be populated with the value of the corresponding accountNumberType of the recipient.
|
|||
accountNumberType | string | depends | read close |
close
DescriptionDefines the account number type of the recipient. Possible values are:
|
|||
object | no | read close | |
close
DescriptionObject containing the address details of the recipient of an account funding transaction.
|
|||
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends depends no depends depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no depends no no depends | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
dateOfBirth | string (8) | depends | read close |
close
DescriptionThe date of birth of the recipient
Format: YYYYMMDD |
|||
object | depends | read close | |
close
DescriptionObject containing the name details of the recipient of an account funding transaction.
|
|||
firstName | string (15) | yes | read close |
close
DescriptionGiven name(s) or first name(s) of the recipient of an account funding transaction.
|
|||
surname | string (70) | yes | read close |
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
partialPan | string (10) | depends | read close |
close
DescriptionEither partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
|
|||
object | no depends no depends depends | read close | |
agentNumericCode | string (8) | no | read close |
close
DescriptionNumeric code identifying the agent
|
|||
code | string (3) | no | read close |
close
DescriptionAirline numeric code
|
|||
flightDate | string (8) | no depends no no depends | read close |
close
DescriptionDate of the Flight
Format: YYYYMMDD |
|||
array of object | no depends no no depends | read close | |
close
DescriptionObject that holds the data on the individual legs of the ticket
|
|||
object | no | read close | |
airlineClass | string | no | read close |
close
DescriptionReservation Booking Designator
|
|||
arrivalAirport | string (3) | no depends no no depends | read close |
close
DescriptionArrival airport/city code
|
|||
arrivalTime | string | no | read close |
close
DescriptionThe arrival time in the local time zone
Format: HH:MM |
|||
carrierCode | string (2) | no | read close |
close
DescriptionIATA carrier code
|
|||
conjunctionTicket | string (14) | no | read close |
close
DescriptionIdentifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
|
|||
couponNumber | string (1) | no | read close |
close
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
|
|||
date | string (8) | no depends no no depends | read close |
close
DescriptionDate of the leg
Format: YYYYMMDD |
|||
departureTime | string (6) | depends | read close |
close
DescriptionThe departure time in the local time at the departure airport
Format: HH:MM |
|||
endorsementOrRestriction | string (20) | no | read close |
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
|
|||
exchangeTicket | string (15) | no | read close |
close
DescriptionNew ticket number that is issued when a ticket is exchanged
|
|||
fare | string (12) | no | read close |
close
DescriptionFare of this leg
|
|||
fareBasis | string (15) | no | read close |
close
DescriptionFare Basis/Ticket Designator
|
|||
fee | integer | no | read close |
close
DescriptionFee for this leg of the trip
|
|||
flightNumber | string (4) | depends | read close |
close
DescriptionThe flight number assigned by the airline carrier with no leading spaces
Should be a numeric string |
|||
number | integer (5) | no | read close |
close
DescriptionSequence number of the flight leg
|
|||
originAirport | string (3) | no depends no no depends | read close |
close
DescriptionOrigin airport/city code
|
|||
passengerClass | string | no | read close |
close
DescriptionPassengerClass if this leg
|
|||
serviceClass | enum | no | read close |
close
Deprecated:
Use passengerClass instead
DescriptionServiceClass of this leg (this property is used for fraud screening on the Ogone Payment Platform).
Possible values are:
|
|||
stopoverCode | string | depends | read close |
close
DescriptionPossible values are:
|
|||
taxes | integer | no | read close |
close
DescriptionTaxes for this leg of the trip
|
|||
invoiceNumber | string (6) | no | read close |
close
DescriptionAirline tracing number
|
|||
isETicket | boolean | no | read close |
close
Description
|
|||
isRegisteredCustomer | boolean | no | read close |
close
Deprecated:
Use order.customer.accountType instead
Description
|
|||
isRestrictedTicket | boolean | no | read close |
close
Description
|
|||
isThirdParty | boolean | no | read close |
close
Description
|
|||
issueDate | string (8) | no | read close |
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 |
|||
merchantCustomerId | string (16) | no | read close |
close
DescriptionYour ID of the customer in the context of the airline data
|
|||
name | string (20) | no | read close |
close
DescriptionName of the airline
|
|||
numberInParty | integer | no | read close |
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.
|
|||
passengerName | string (49) | no depends no no depends | read close |
close
DescriptionName of passenger
|
|||
array of object | no | read close | |
close
DescriptionObject that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
|
|||
object | no | read close | |
firstName | string (15) | no | read close |
close
DescriptionFirst name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
surname | string (70) | no | read close |
close
DescriptionSurname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionSurname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
title | string (35) | no | read close |
close
DescriptionTitle of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
placeOfIssue | string (15) | no | read close |
close
DescriptionPlace of issue
For sales in the US the last two characters (pos 14-15) must be the US state code. |
|||
pnr | string (127) | no depends no no depends | read close |
close
DescriptionPassenger name record
|
|||
pointOfSale | string (25) | no | read close |
close
DescriptionIATA point of sale name
|
|||
posCityCode | string (10) | no | read close |
close
Descriptioncity code of the point of sale
|
|||
ticketDeliveryMethod | string | no | read close |
close
DescriptionPossible values:
|
|||
ticketNumber | string (13) | no | read close |
close
DescriptionThe ticket or document number. On the Ogone Payment Platform and the GlobalCollect Payment Platform it contains:
|
|||
totalFare | integer | no | read close |
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
|
|||
totalFee | integer | no | read close |
close
DescriptionTotal fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
|
|||
totalTaxes | integer | no | read close |
close
DescriptionTotal taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
|
|||
travelAgencyName | string (25) | no | read close |
close
DescriptionName of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.
|
|||
object | no | read close | |
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.
|
|||
object | no | read close | |
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.
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no | read close | |
close
DescriptionObject containing the total amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
frequencyOfInstallments | string | no | read close |
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. |
|||
installmentPlanCode | integer | no | read close |
close
DescriptionThe code for the installment plan. The possible values are:
|
|||
interestRate | string | no | read close |
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. |
|||
numberOfInstallments | integer (5) | no depends no yes no | read close |
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. |
|||
object | no | read close | |
close
Deprecated:
Use order.shoppingCart.amountBreakdown instead
DescriptionObject that holds Level3 summary data
|
|||
discountAmount | integer (12) | no | read close |
close
Deprecated:
Use order.shoppingCart.amountBreakdown with type DISCOUNT instead
DescriptionDiscount on the entire transaction, with the last 2 digits are implied decimal places
|
|||
dutyAmount | integer (12) | no | read close |
close
Deprecated:
Use order.shoppingCart.amountBreakdown with type DUTY instead
DescriptionDuty on the entire transaction, with the last 2 digits are implied decimal places
|
|||
shippingAmount | integer (12) | no | read close |
close
Deprecated:
Use order.shoppingCart.amountBreakdown with type SHIPPING instead
DescriptionShippingcost on the entire transaction, with the last 2 digits are implied decimal places
|
|||
object | depends | read close | |
close
Deprecated:
No replacement
DescriptionObject containing specific data regarding the recipient of a loan in the UK
|
|||
accountNumber | string (10) | depends | read close |
close
Deprecated:
No replacement
DescriptionShould be filled with the last 10 digits of the bank account number of the recipient of the loan.
|
|||
dateOfBirth | string (8) | depends | read close |
close
Deprecated:
No replacement
DescriptionThe date of birth of the customer of the recipient of the loan.
Format: YYYYMMDD |
|||
partialPan | string (10) | depends | read close |
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.
|
|||
surname | string (12) | depends | read close |
close
Deprecated:
No replacement
DescriptionSurname of the recipient of the loan.
|
|||
zip | string (10) | depends | read close |
close
Deprecated:
No replacement
DescriptionZip code of the recipient of the loan
|
|||
object | no | read close | |
array of object | no | read close | |
close
DescriptionObject that holds lodging related charges
|
|||
object | no | read close | |
chargeAmount | integer (12) | no | read close |
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. |
|||
chargeAmountCurrencyCode | string (3) | no | read close |
close
DescriptionCurrency for Charge amount. The code should be in 3 letter ISO format.
|
|||
chargeType | string | no | read close |
close
DescriptionType of additional charges associated with the stay of the guest.
Allowed values:
|
|||
checkInDate | string (8) | no | read close |
close
DescriptionThe date the guest checks into (or plans to check in to) the facility.
Format: YYYYMMDD |
|||
checkOutDate | string (8) | no | read close |
close
DescriptionThe date the guest checks out of (or plans to check out of) the facility.
Format: YYYYMMDD |
|||
folioNumber | string (25) | no | read close |
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.
|
|||
isConfirmedReservation | boolean | no | read close |
close
DescriptionIndicates whether the room reservation is confirmed.
|
|||
isFacilityFireSafetyConform | boolean | no | read close |
close
DescriptionDefines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation.
|
|||
isNoShow | boolean | no | read close |
close
DescriptionIndicate if this the customer is a no show case. In such case, the lodging property can charge a no show fee.
|
|||
isPreferenceSmokingRoom | boolean | no | read close |
close
DescriptionIndicated the preference of the customer for a smoking or non-smoking room.
|
|||
numberOfAdults | integer (3) | no | read close |
close
DescriptionThe total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)
|
|||
numberOfNights | integer (4) | no | read close |
close
DescriptionThe number of nights for the lodging stay
|
|||
numberOfRooms | integer (4) | no | read close |
close
DescriptionThe number of rooms rented for the lodging stay
|
|||
programCode | string | no | read close |
close
DescriptionCode that corresponds to the category of lodging charges detailed in this message.
Allowed values:
|
|||
propertyCustomerServicePhoneNumber | string (20) | no | read close |
close
DescriptionThe international customer service phone number of the facility
|
|||
propertyPhoneNumber | string (20) | no | read close |
close
DescriptionThe local phone number of the facility in an international phone number format
|
|||
renterName | string (26) | no | read close |
close
DescriptionName of the person or business entity charged for the reservation and/or lodging stay
|
|||
array of object | no | read close | |
close
DescriptionObject that holds lodging related room data
|
|||
object | no | read close | |
dailyRoomRate | string (12) | no | read close |
close
DescriptionDaily room rate exclusive of any taxes and fees
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode. |
|||
dailyRoomRateCurrencyCode | string (3) | no | read close |
close
DescriptionCurrency for Daily room rate. The code should be in 3 letter ISO format
|
|||
dailyRoomTaxAmount | string (12) | no | read close |
close
DescriptionDaily room tax
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode. |
|||
dailyRoomTaxAmountCurrencyCode | string (3) | no | read close |
close
DescriptionCurrency for Daily room tax. The code should be in 3 letter ISO format
|
|||
numberOfNightsAtRoomRate | integer (4) | no | read close |
close
DescriptionNumber of nights charged at the rate in the dailyRoomRate property
|
|||
roomLocation | string (10) | no | read close |
close
DescriptionLocation of the room within the facility, e.g. Park or Garden etc.
|
|||
roomNumber | string (6) | no | read close |
close
DescriptionRoom number
|
|||
typeOfBed | string (12) | no | read close |
close
DescriptionSize of bed, e.g., king, queen, double.
|
|||
typeOfRoom | string (12) | no | read close |
close
DescriptionDescribes the type of room, e.g., standard, deluxe, suite.
|
|||
numberOfInstallments | integer (5) | no | read close |
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.
|
|||
orderDate | string (14) | no | read close |
close
DescriptionDate and time of order
Format: YYYYMMDDHH24MISS |
|||
object | no | read close | |
close
DescriptionObject that holds the purchase and usage type indicators
|
|||
fundingType | string | depends | read close |
close
DescriptionIdentifies the funding type being authenticated. Possible values are:
|
|||
paymentCode | string | no | read close |
close
DescriptionPayment code to support account funding transactions. Possible values are:
|
|||
purchaseType | string | no | read close |
close
DescriptionPossible values are:
|
|||
transactionType | string | depends | read close |
close
DescriptionIdentifies the type of transaction being authenticated.
Possible values are:
|
|||
usageType | string | no | read close |
close
DescriptionPossible values are:
|
|||
object | yes | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | depends | read close | |
object | no | read close | |
close
DescriptionObject containing data related to the account the customer has with you
|
|||
object | no | read close | |
close
DescriptionObject containing data on the authentication used by the customer to access their account
|
|||
data | string (20000) | no | read close |
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:
|
|||
method | string | depends | read close |
close
DescriptionAuthentication used by the customer on your website or app
Possible values :
|
|||
utcTimestamp | string (12) | no | read close |
close
DescriptionTimestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
|
|||
changeDate | string (8) | no | read close |
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.
|
|||
changedDuringCheckout | boolean | no | read close |
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. |
|||
createDate | string (8) | no | read close |
close
DescriptionThe date (YYYYMMDD) on which the customer created their account with you
|
|||
hadSuspiciousActivity | boolean | no | read close |
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 |
|||
hasForgottenPassword | boolean | no | read close |
close
DescriptionSpecifies if the customer (initially) had forgotten their password
|
|||
hasPassword | boolean | no | read close |
close
DescriptionSpecifies if the customer entered a password to gain access to an account registered with the you
|
|||
passwordChangeDate | string (8) | no | read close |
close
DescriptionThe last date (YYYYMMDD) on which the customer changed their password for the account used in this transaction
|
|||
passwordChangedDuringCheckout | boolean | no | read close |
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 |
|||
object | no | read close | |
close
DescriptionObject containing information on the payment account data on file (tokens)
|
|||
createDate | string (8) | no | read close |
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. |
|||
numberOfCardOnFileCreationAttemptsLast24Hours | integer (3) | no | read close |
close
DescriptionNumber of attempts made to add new card to the customer account in the last 24 hours
|
|||
paymentAccountOnFileType | string | depends | read close |
close
DescriptionIndicates the type of account. For example, for a multi-account card product.
|
|||
object | no | read close | |
close
DescriptionObject containing data on the purchase history of the customer with you
|
|||
numberOfPaymentAttemptsLast24Hours | integer (3) | no | read close |
close
DescriptionNumber of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours
|
|||
numberOfPaymentAttemptsLastYear | integer (3) | no | read close |
close
DescriptionNumber of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months
|
|||
numberOfPurchasesLast6Months | integer (4) | no | read close |
close
DescriptionNumber of successful purchases made by this customer with you in the last 6 months
|
|||
accountType | string | no | read close |
close
DescriptionType of the customer account that is used to place this order. Can have one of the following values:
|
|||
object | depends | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends depends no depends depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no depends no no depends | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | depends depends no no depends | read close | |
dateOfIncorporation | string (8) | no depends no no depends | read close |
close
DescriptionThe date of incorporation is the specific date when the company was registered with the relevant authority.
Format: YYYYMMDD |
|||
name | string (40) | depends depends no no no | read close |
close
DescriptionName of company, as a customer
|
|||
vatNumber | string (17) | depends | read close |
close
DescriptionLocal VAT number of the company
|
|||
object | depends depends no depends yes | read close | |
close
DescriptionObject containing contact details like email address and phone number
|
|||
emailAddress | string (70) | depends depends no depends depends | read close |
close
DescriptionEmail address of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
emailMessageType | string | no | read close |
close
DescriptionPreference for the type of email message markup
|
|||
faxNumber | string (20) | no | read close |
close
DescriptionFax number of the customer
|
|||
mobilePhoneNumber | string (20) | depends depends no depends depends | read close |
close
DescriptionInternational version of the mobile phone number of the customer including the leading + (i.e. +16127779311).
|
|||
phoneNumber | string (20) | depends depends no depends depends | read close |
close
DescriptionPhone number of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
workPhoneNumber | string (20) | no depends no depends no | read close |
close
DescriptionInternational version of the work phone number of the customer including the leading + (i.e. +31235671500)
|
|||
object | depends depends no no depends | read close | |
close
DescriptionObject containing information on the device and browser of the customer
|
|||
acceptHeader | string (2048) | depends | read close |
close
DescriptionThe accept-header of the customer client from the HTTP Headers.
|
|||
object | depends depends no no no | read close | |
close
DescriptionObject containing information regarding the browser of the customer
|
|||
colorDepth | integer (2) | depends | read close |
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". |
|||
innerHeight | string (6) | no | read close |
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.
|
|||
innerWidth | string (6) | no | read close |
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.
|
|||
javaEnabled | boolean | depends | read close |
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". |
|||
javaScriptEnabled | boolean | depends | read close |
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. |
|||
screenHeight | string (6) | depends | read close |
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". |
|||
screenWidth | string (6) | depends | read close |
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". |
|||
defaultFormFill | string | no | read close |
close
DescriptionDegree of default form fill, with the following possible values:
|
|||
deviceFingerprintTransactionId | string | no | read close |
close
DescriptionOne must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
|
|||
ipAddress | string (45) | depends depends depends depends depends | read close |
close
DescriptionThe IP address of the customer client from the HTTP Headers.
|
|||
locale | string (8) | depends depends depends depends no | read close |
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. |
|||
timezoneOffsetUtcMinutes | string (6) | depends depends depends depends no | read close |
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. |
|||
userAgent | string (2048) | depends depends depends depends depends | read close |
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. |
|||
fiscalNumber | string (14) | depends | read close |
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:
|
|||
isCompany | boolean | no | read close |
close
DescriptionIndicates if the payer is a company or an individual
|
|||
isPreviousCustomer | boolean | no | read close |
close
DescriptionSpecifies if the customer has a history of online shopping with the merchant
|
|||
locale | string (6) | depends | read close |
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.
|
|||
merchantCustomerId | string (15) | depends | read close |
close
DescriptionYour identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
|
|||
object | depends depends no depends depends | read close | |
close
DescriptionObject containing personal information like name, date of birth and gender.
|
|||
dateOfBirth | string (8) | no depends no depends depends | read close |
close
DescriptionThe date of birth of the customer
Format: YYYYMMDD |
|||
gender | string | no | read close |
close
DescriptionThe gender of the customer, possible values are:
|
|||
object | depends | read close | |
close
DescriptionObject containing identification documents information
|
|||
idIssuingCountryCode | string (2) | yes | read close |
close
DescriptionISO 3166-1 alpha-2 country code of the country that issued the identification document
|
|||
idType | string | yes | read close |
close
DescriptionIndicates the type of identification
|
|||
idValue | string (70) | yes | read close |
close
DescriptionThe value of the identification
|
|||
object | depends depends no depends depends | read close | |
close
DescriptionObject containing the name details of the customer
|
|||
firstName | string (15) | depends depends no depends depends | read close |
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.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
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.
|
|||
surnamePrefix | string (15) | no | read close |
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.
|
|||
title | string (35) | depends | read close |
close
DescriptionTitle of customer
|
|||
object | no | read close | |
close
Deprecated:
Use order.shipping.address instead
DescriptionObject containing shipping address details
|
|||
additionalInfo | string (50) | no | read close |
close
Deprecated
DescriptionAdditional address information
|
|||
city | string | no depends no no depends | read close |
close
Deprecated
DescriptionCity
|
|||
countryCode | string (2) | no depends no no depends | read close |
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | no | read close |
close
Deprecated
DescriptionHouse number
|
|||
object | no depends no no depends | read close | |
close
Deprecated
DescriptionObject that holds the name elements
|
|||
firstName | string (15) | depends depends no depends depends | read close |
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.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
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.
|
|||
surnamePrefix | string (15) | no | read close |
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.
|
|||
title | string (35) | depends | read close |
close
Deprecated
DescriptionTitle of customer
|
|||
state | string (35) | no depends no no depends | read close |
close
Deprecated
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | no depends no depends depends | read close |
close
Deprecated
DescriptionStreetname
|
|||
zip | string | no depends no depends depends | read close |
close
Deprecated
DescriptionZip code
|
|||
vatNumber | string (17) | no | read close |
close
Deprecated:
Use companyInformation.vatNumber instead
DescriptionLocal VAT number of the company
|
|||
array of object | no | read close | |
close
Deprecated:
Use shoppingCart.items instead
DescriptionShopping cart data
|
|||
object | no | read close | |
object | no depends depends depends yes | read close | |
close
Deprecated
DescriptionObject containing amount and ISO currency code attributes
Note: make sure you submit the amount and currency code for each line item
|
|||
amount | integer (12) | yes | read close |
close
Deprecated
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
Deprecated
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no depends depends depends yes | read close | |
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.
|
|||
description | string (116) | depends | read close |
close
Deprecated
DescriptionShopping cart item description
|
|||
merchantLinenumber | string (5) | no | read close |
close
Deprecated
DescriptionLine number for printed invoice or order of items in the cart
Should be a numeric string |
|||
merchantPagenumber | string (3) | no | read close |
close
Deprecated
DescriptionPage number for printed invoice
Should be a numeric string |
|||
nrOfItems | string (4) | depends | read close |
close
Deprecated
DescriptionQuantity of the item
|
|||
pricePerItem | integer (12) | depends | read close |
close
Deprecated
DescriptionPrice per item
|
|||
object | no | read close | |
close
Deprecated:
Use orderLineDetails instead
DescriptionObject containing additional information that when supplied can have a beneficial effect on the discountrates
|
|||
discountAmount | integer (12) | no | read close |
close
Deprecated
DescriptionDiscount on the line item, with the last two digits are implied decimal places
|
|||
lineAmountTotal | integer (12) | no | read close |
close
Deprecated
DescriptionTotal amount for the line item
|
|||
productCode | string (12) | no | read close |
close
Deprecated
DescriptionProduct or UPC Code, left justified
Note: Must not be all spaces or all zeros |
|||
productPrice | integer (12) | no | read close |
close
Deprecated
DescriptionThe price of one unit of the product, the value should be zero or greater
|
|||
productType | string (12) | no | read close |
close
Deprecated
DescriptionCode used to classify items that are purchased
Note: Must not be all spaces or all zeros |
|||
quantity | integer (4) | no | read close |
close
Deprecated
DescriptionQuantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros |
|||
taxAmount | integer (12) | no | read close |
close
Deprecated
DescriptionTax on the line item, with the last two digits are implied decimal places
|
|||
unit | string (12) | no | read close |
close
Deprecated
DescriptionIndicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
|
|||
object | no depends no depends yes | read close | |
close
Deprecated
DescriptionObject containing additional information that when supplied can have a beneficial effect on the discountrates
|
|||
discountAmount | integer (12) | no | read close |
close
Deprecated
DescriptionDiscount on the line item, with the last two digits implied as decimal places
|
|||
googleProductCategoryId | integer (10) | no | read close |
close
Deprecated
DescriptionThe Google product category ID for the item.
|
|||
lineAmountTotal | integer (12) | depends | read close |
close
Deprecated
DescriptionTotal amount for the line item
|
|||
naicsCommodityCode | string (6) | no | read close |
close
Deprecated
DescriptionThe UNSPC commodity code of the item.
|
|||
productCategory | string (50) | no | read close |
close
Deprecated
DescriptionThe category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
|
|||
productCode | string (12) | yes depends depends depends yes | read close |
close
Deprecated
DescriptionProduct or UPC Code, left justified
Note: Must not be all spaces or all zeros |
|||
productName | string (120) | no depends no depends yes | read close |
close
Deprecated
DescriptionThe name of the product. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
productPrice | integer (12) | yes depends depends depends depends | read close |
close
Deprecated
DescriptionThe price of one unit of the product, the value should be zero or greater
|
|||
productSku | string (12) | no | read close |
close
Deprecated
DescriptionProduct SKU number
|
|||
productType | string (12) | depends | read close |
close
Deprecated
DescriptionCode used to classify items that are purchased
Note: Must not be all spaces or all zeros |
|||
quantity | integer (4) | yes depends depends depends depends | read close |
close
Deprecated
DescriptionQuantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros |
|||
taxAmount | integer (12) | no | read close |
close
Deprecated
DescriptionTax on the line item, with the last two digits implied as decimal places
|
|||
unit | string (12) | no | read close |
close
Deprecated
DescriptionIndicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
|
|||
object | depends | read close | |
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
descriptor | string (256) | no | read close |
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:
|
|||
object | no | read close | |
additionalData | string (500) | no | read close |
close
DescriptionAdditional data for printed invoices
|
|||
invoiceDate | string (14) | no | read close |
close
DescriptionDate and time on invoice
Format: YYYYMMDDHH24MISS |
|||
invoiceNumber | string (20) | no | read close |
close
DescriptionYour invoice number (on printed invoice) that is also returned in our report files
|
|||
textQualifiers | array | no | read close |
close
DescriptionArray of 3 text qualifiers, each with a max length of 10 characters
|
|||
merchantOrderId | integer (10) | no | read close |
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. |
|||
merchantReference | string | no depends no depends yes | read close |
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. |
|||
providerId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
providerMerchantId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
object | no | read close | |
close
Deprecated:
Use merchant.seller instead
DescriptionObject containing seller details
|
|||
object | no | read close | |
close
Deprecated
DescriptionObject containing the seller address details
|
|||
additionalInfo | string (50) | no | read close |
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
|
|||
city | string | depends depends no depends depends | read close |
close
Deprecated
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
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
|
|||
state | string (35) | no depends no no depends | read close |
close
Deprecated
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
Deprecated
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
Deprecated
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
channelCode | string (3) | no | read close |
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.
|
|||
description | string (32) | no | read close |
close
Deprecated
DescriptionDescription of the seller
|
|||
externalReferenceId | string (15) | no | read close |
close
Deprecated
DescriptionSeller ID assigned by the Merchant Aggregator
|
|||
geocode | string (5) | no | read close |
close
Deprecated
DescriptionThe sellers geocode
|
|||
id | string (40) | no depends no yes no | read close |
close
Deprecated
DescriptionThe sellers identifier
|
|||
invoiceNumber | string (12) | no | read close |
close
Deprecated
DescriptionInvoice number of the payment
|
|||
isForeignRetailer | boolean | no | read close |
close
Deprecated
DescriptionIndicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values:
|
|||
mcc | string (5) | no | read close |
close
Deprecated
DescriptionMerchant category code
|
|||
name | string (128) | no depends no yes no | read close |
close
Deprecated
DescriptionName of the seller
|
|||
phoneNumber | string (32) | no | read close |
close
Deprecated
DescriptionMain Phone Number
|
|||
type | string | no depends no yes no | read close |
close
Deprecated
DescriptionSeller type. Possible values:
|
|||
object | no depends no no depends | read close | |
close
DescriptionObject containing information regarding shipping / delivery
|
|||
object | no depends no no depends | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information
|
|||
city | string | no depends no no depends | read close |
close
DescriptionCity
|
|||
countryCode | string (2) | no depends no no depends | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | no | read close |
close
DescriptionHouse number
|
|||
object | no depends no no depends | read close | |
firstName | string (15) | depends depends no depends depends | read close |
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.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
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.
|
|||
surnamePrefix | string (15) | no | read close |
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.
|
|||
title | string (35) | depends | read close |
close
DescriptionTitle of customer
|
|||
state | string (35) | no depends no no depends | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | no depends no depends depends | read close |
close
DescriptionStreetname
|
|||
zip | string | no depends no depends depends | read close |
close
DescriptionZip code
|
|||
addressIndicator | string | no | read close |
close
DescriptionIndicates shipping method chosen for the transaction. Possible values:
|
|||
comments | string (160) | no | read close |
close
DescriptionComments included during shipping
|
|||
emailAddress | string (70) | no depends no no depends | read close |
close
DescriptionEmail address linked to the shipping
|
|||
firstUsageDate | string (8) | no | read close |
close
DescriptionDate (YYYYMMDD) when the shipping details for this transaction were first used.
|
|||
isFirstUsage | boolean | no | read close |
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 |
|||
shippedFromZip | string (10) | no | read close |
close
DescriptionThe zip/postal code of the location from which the goods were shipped.
|
|||
trackingNumber | string (19) | no | read close |
close
DescriptionShipment tracking number
|
|||
type | string | no | read close |
close
DescriptionIndicates the merchandise delivery timeframe. Possible values:
|
|||
object | no depends no depends yes | read close | |
close
DescriptionShopping cart data, including items and specific amounts.
|
|||
array of object | no | read close | |
close
DescriptionDetermines the type of the amount.
|
|||
object | no | read close | |
amount | integer | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
type | enum | yes | read close |
close
DescriptionType of the amount. Each type is only allowed to be provided once. Allowed values:
|
|||
object | no | read close | |
close
DescriptionObject containing information on purchased gift card(s)
|
|||
object | no | read close | |
close
DescriptionObject containing information on an amount of money
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
numberOfGiftCards | integer (2) | no | read close |
close
DescriptionNumber of gift cards that are purchased through this transaction
|
|||
isPreOrder | boolean | no | read close |
close
DescriptionThe customer is pre-ordering one or more items
|
|||
array of object | no depends depends depends yes | read close | |
close
DescriptionShopping cart data
|
|||
object | no | read close | |
object | no depends depends depends yes | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
Note: make sure you submit the amount and currency code for each line item
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no depends depends depends yes | read close | |
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.
|
|||
description | string (116) | depends | read close |
close
DescriptionShopping cart item description
|
|||
merchantLinenumber | string (5) | no | read close |
close
DescriptionLine number for printed invoice or order of items in the cart
Should be a numeric string |
|||
merchantPagenumber | string (3) | no | read close |
close
DescriptionPage number for printed invoice
Should be a numeric string |
|||
nrOfItems | string (4) | depends | read close |
close
DescriptionQuantity of the item
|
|||
pricePerItem | integer (12) | depends | read close |
close
DescriptionPrice per item
|
|||
object | no | read close | |
close
Deprecated:
Use orderLineDetails instead
DescriptionObject containing additional information that when supplied can have a beneficial effect on the discountrates
|
|||
discountAmount | integer (12) | no | read close |
close
Deprecated
DescriptionDiscount on the line item, with the last two digits are implied decimal places
|
|||
lineAmountTotal | integer (12) | no | read close |
close
Deprecated
DescriptionTotal amount for the line item
|
|||
productCode | string (12) | no | read close |
close
Deprecated
DescriptionProduct or UPC Code, left justified
Note: Must not be all spaces or all zeros |
|||
productPrice | integer (12) | no | read close |
close
Deprecated
DescriptionThe price of one unit of the product, the value should be zero or greater
|
|||
productType | string (12) | no | read close |
close
Deprecated
DescriptionCode used to classify items that are purchased
Note: Must not be all spaces or all zeros |
|||
quantity | integer (4) | no | read close |
close
Deprecated
DescriptionQuantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros |
|||
taxAmount | integer (12) | no | read close |
close
Deprecated
DescriptionTax on the line item, with the last two digits are implied decimal places
|
|||
unit | string (12) | no | read close |
close
Deprecated
DescriptionIndicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
|
|||
object | no depends no depends yes | read close | |
close
DescriptionObject containing additional information that when supplied can have a beneficial effect on the discountrates
|
|||
discountAmount | integer (12) | no | read close |
close
DescriptionDiscount on the line item, with the last two digits implied as decimal places
|
|||
googleProductCategoryId | integer (10) | no | read close |
close
DescriptionThe Google product category ID for the item.
|
|||
lineAmountTotal | integer (12) | depends | read close |
close
DescriptionTotal amount for the line item
|
|||
naicsCommodityCode | string (6) | no | read close |
close
DescriptionThe UNSPC commodity code of the item.
|
|||
productCategory | string (50) | no | read close |
close
DescriptionThe category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
|
|||
productCode | string (12) | yes depends depends depends yes | read close |
close
DescriptionProduct or UPC Code, left justified
Note: Must not be all spaces or all zeros |
|||
productName | string (120) | no depends no depends yes | read close |
close
DescriptionThe name of the product. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
productPrice | integer (12) | yes depends depends depends depends | read close |
close
DescriptionThe price of one unit of the product, the value should be zero or greater
|
|||
productSku | string (12) | no | read close |
close
DescriptionProduct SKU number
|
|||
productType | string (12) | depends | read close |
close
DescriptionCode used to classify items that are purchased
Note: Must not be all spaces or all zeros |
|||
quantity | integer (4) | yes depends depends depends depends | read close |
close
DescriptionQuantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros |
|||
taxAmount | integer (12) | no | read close |
close
DescriptionTax on the line item, with the last two digits implied as decimal places
|
|||
unit | string (12) | no | read close |
close
DescriptionIndicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
|
|||
preOrderItemAvailabilityDate | string (8) | no | read close |
close
DescriptionDate (YYYYMMDD) when the preordered item becomes available
|
|||
reOrderIndicator | boolean | no | read close |
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 |
Request example
This scenario you will probably use the most
-
// Assigning literals to pointer variables directly is not supported. // The below code uses helper function connectsdk.NewString to overcome this issue. // This helper function is provided by the SDK's root package. // http://stackoverflow.com/a/30716481 lists a few more alternatives. var card domain.CardWithoutCvv card.CardNumber = connectsdk.NewString("67030000000000003") card.CardholderName = connectsdk.NewString("Wile E. Coyote") card.ExpiryDate = connectsdk.NewString("1299") var cardPaymentMethodSpecificInput domain.CompletePaymentCardPaymentMethodSpecificInput cardPaymentMethodSpecificInput.Card = &card var body domain.CompletePaymentRequest body.CardPaymentMethodSpecificInput = &cardPaymentMethodSpecificInput response, err := client.V1().Merchant("merchantId").Payments().Complete("paymentId", body, nil)
Responses
Please find below an overview of the possible responses.
Response 200 - OKdomain.CompletePaymentResponse
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
|
|||
additionalReference | string | no | read close |
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.
|
|||
externalReference | string | no | read close |
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.
|
|||
isCheckedRememberMe | boolean | no | read close |
close
DescriptionIndicates whether the customer ticked the "Remember my details for future purchases" checkbox on the MyCheckout hosted payment pages
|
|||
isNewToken | boolean | no | read close |
close
DescriptionIndicates if a new token was created
|
|||
token | string | no | read close |
close
DescriptionID of the token
|
|||
tokenizationSucceeded | boolean | no | read close |
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
|
|||
actionType | enum | no | read close |
close
DescriptionAction merchants needs to take in the online payment process. Possible values are:
|
|||
array of object | no | read close | |
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.
|
|||
object | no | read close | |
object | no | read close | |
close
DescriptionObject containing data restrictions that apply to this field, like minimum and/or maximum length
|
|||
isRequired | boolean | no | read close |
close
Description
|
|||
object | no | read close | |
close
DescriptionObject containing the details of the validations on the field
|
|||
object | no | read close | |
close
DescriptionIndicates the requiredness of the field based on the fiscalnumber for Boleto Bancario
|
|||
fiscalNumberLength | integer | no | read close |
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.
|
|||
emailAddress | object | no | read close |
close
DescriptionIndicates that the content should be validated against the rules for an email address
|
|||
expirationDate | object | no | read close |
close
DescriptionIndicates that the content should be validated against the rules for an expiration date (it should be in the future)
|
|||
object | no | read close | |
close
DescriptionIndicates that content should be one of the, in this object, listed items
|
|||
allowedValues | array | no | read close |
close
DescriptionList of the allowed values that the field will be validated against
|
|||
iban | object | no | read close |
close
DescriptionIndicates that the content of this (iban) field needs to validated against format checks and modulo check (as described in ISO 7064)
|
|||
object | no | read close | |
close
DescriptionIndicates that the content needs to be validated against length criteria defined in this object
|
|||
maxLength | integer | no | read close |
close
DescriptionThe maximum allowed length
|
|||
minLength | integer | no | read close |
close
DescriptionThe minimum allowed length
|
|||
luhn | object | no | read close |
close
DescriptionIndicates that the content needs to be validated using a LUHN check
|
|||
object | no | read close | |
close
DescriptionIndicates that the content needs to be validated against a, in this object, defined range
|
|||
maxValue | integer | no | read close |
close
DescriptionUpper value of the range that is still valid
|
|||
minValue | integer | no | read close |
close
DescriptionLower value of the range that is still valid
|
|||
object | no | read close | |
close
DescriptionA string representing the regular expression to check
|
|||
regularExpression | string | no | read close |
close
DescriptionContains the regular expression that the value of the field needs to be validated against
|
|||
residentIdNumber | object | no | read close |
close
DescriptionIndicates that the content needs to be validated as per the Chinese resident identity number format
|
|||
termsAndConditions | object | no | read close |
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
|
|||
object | no | read close | |
close
DescriptionObject containing display hints for this field, like the order, mask, preferred keyboard
|
|||
alwaysShow | boolean | no | read close |
close
Description
|
|||
displayOrder | integer | no | read close |
close
DescriptionThe order in which the fields should be shown (ascending)
|
|||
object | no | read close | |
close
DescriptionObject detailing the type of form element that should be used to present the field
|
|||
type | string | no | read close |
close
DescriptionType of form element to be used. The following types can be returned:
|
|||
array of object | no | read close | |