Approve payment

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

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

When you are ready to capture the funds on a payment with a PENDING_APPROVAL state you can call this API. This API will request the transaction to be captured. Depending on the payment product and the 3rd party used to process the payment this is done in real-time or in a more off-line, batch-like fashion.

Based on how your account has been configured, transactions will require this second step before the funds are actually captured.

PENDING_APPROVAL is a common status only with card and direct debit transactions. Only with special configuration is it possible to also have this for PayPal transactions.

Note that the PENDING_APPROVAL status is used for payments that only allow a single capture. Such a capture will update the status of the payment. The similar PENDING_CAPTURE status is used for payments that allow multiple captures. These captures can be done using the capture payment API and result in a new Capture object. In case you want to capture a lower amount then the authorized amount you can specify the amount you would like to be captured. It is also possible to provide some updated information (airline data, references) and/or details on the signed direct debit mandate.

PayloadApprovePaymentRequest

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
amount	integer (12)	no	read close
close Description In case you want to approve the capture of a different lower amount you can specify this here (specified in cents, where single digit currencies are presumed to have 2 digits)
Group directDebitPaymentMethodSpecificInput	object	no	read close
close Description Object that holds non-SEPA Direct Debit specific input data SDK Object type ApprovePaymentNonSepaDirectDebitPaymentMethodSpecificInput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
dateCollect	string (8)	no	read close
close Description The desired date for the collection Format: YYYYMMDD
token	string (40)	no	read close
close Description Token containing tokenized bank account details
Group sepaDirectDebitPaymentMethodSpecificInput	object	no	read close
close Description Object that holds SEPA Direct Debit specific input data SDK Object type ApprovePaymentSepaDirectDebitPaymentMethodSpecificInput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
dateCollect	string (8)	no	read close
close Description The desired date for the collection Format: YYYYMMDD
token	string (40)	no	read close
close Description Token containing tokenized bank account details
order	object	no	read close
close Description Object that holds the order data SDK Object type OrderApprovePayment
additionalInput	object	no	read close
close Description Object containing additional input on the order SDK Object type AdditionalOrderInputAirlineData
airlineData	object	no	read close
close Description Object that holds airline specific data SDK Object type AirlineData
agentNumericCode	string (8)	no	read close
close Description Numeric code identifying the agent
code	string (3)	no	read close
close Description Airline numeric code
flightDate	string (8)	no depends no no depends	read close
close Description Date of the Flight Format: YYYYMMDD Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
flightLegs	array of object	no depends no no depends	read close
close Description Object that holds the data on the individual legs of the ticket Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
items	object	no	read close
close SDK Object type AirlineFlightLeg
airlineClass	string	no	read close
close Description Reservation Booking Designator
arrivalAirport	string (3)	no depends no no depends	read close
close Description Arrival airport/city code Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
arrivalTime	string	no	read close
close Description The arrival time in the local time zone Format: HH:MM
carrierCode	string (2)	no	read close
close Description IATA carrier code
conjunctionTicket	string (14)	no	read close
close Description Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
couponNumber	string (1)	no	read close
close Description The coupon number associated with this leg of the trip. A ticket can contain several legs of travel, and each leg of travel requires a separate coupon
date	string (8)	no depends no no depends	read close
close Description Date of the leg Format: YYYYMMDD Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
departureTime	string (6)	depends	read close
close Description The departure time in the local time at the departure airport Format: HH:MM Depends on: Required for PayPal (840) when Airline data is submitted
endorsementOrRestriction	string (20)	no	read close
close Description An endorsement can be an agency-added notation or a mandatory government required notation, such as value-added tax. A restriction is a limitation based on the type of fare, such as a ticket with a 3-day minimum stay
exchangeTicket	string (15)	no	read close
close Description New ticket number that is issued when a ticket is exchanged
fare	string (12)	no	read close
close Description Fare of this leg
fareBasis	string (15)	no	read close
close Description Fare Basis/Ticket Designator
fee	integer	no	read close
close Description Fee for this leg of the trip
flightNumber	string (4)	depends	read close
close Description The flight number assigned by the airline carrier with no leading spaces Should be a numeric string Depends on: Required for PayPal (840) when Airline data is submitted
number	integer (5)	no	read close
close Description Sequence number of the flight leg
originAirport	string (3)	no depends no no depends	read close
close Description Origin airport/city code Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
passengerClass	string	no	read close
close Description PassengerClass if this leg
serviceClass	enum	no	read close
close Deprecated: Use passengerClass instead Description ServiceClass of this leg (this property is used for fraud screening on the Ogone Payment Platform). Possible values are: economy premium-economy business first
stopoverCode	string	depends	read close
close Description Possible values are: permitted = Stopover permitted non-permitted = Stopover not permitted Depends on: Required for PayPal (840) when Airline data is submitted
taxes	integer	no	read close
close Description Taxes for this leg of the trip
invoiceNumber	string (6)	no	read close
close Description Airline tracing number
isETicket	boolean	no	read close
close Description true = The ticket is an E-Ticket false = the ticket is not an E-Ticket
isRegisteredCustomer	boolean	no	read close
close Deprecated: Use order.customer.accountType instead Description true = a registered known customer false = unknown customer
isRestrictedTicket	boolean	no	read close
close Description true - Restricted, the ticket is non-refundable false - No restrictions, the ticket is (partially) refundable
isThirdParty	boolean	no	read close
close Description true - The payer is the ticket holder false - The payer is not the ticket holder
issueDate	string (8)	no	read close
close Description This is the date of issue recorded in the airline system In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date. Format: YYYYMMDD
merchantCustomerId	string (16)	no	read close
close Description Your ID of the customer in the context of the airline data
name	string (20)	no	read close
close Description Name of the airline
numberInParty	integer	no	read close
close Description Total number of passengers in the party. If the the property numberInParty is not present, then the number of passengers will be used on the WL Online Payment Acceptance Platform.
passengerName	string (49)	no depends no no depends	read close
close Description Name of passenger Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
passengers	array of object	no	read close
close Description Object that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
items	object	no	read close
close SDK Object type AirlinePassenger
firstName	string (15)	no	read close
close Description First name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
surname	string (70)	no	read close
close Description Surname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
surnamePrefix	string (15)	no	read close
close Description Surname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
title	string (35)	no	read close
close Description Title of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
placeOfIssue	string (15)	no	read close
close Description Place of issue For sales in the US the last two characters (pos 14-15) must be the US state code.
pnr	string (127)	no depends no no depends	read close
close Description Passenger name record Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
pointOfSale	string (25)	no	read close
close Description IATA point of sale name
posCityCode	string (10)	no	read close
close Description city code of the point of sale
ticketDeliveryMethod	string	no	read close
close Description Possible values: e-ticket city-ticket-office airport-ticket-office ticket-by-mail ticket-on-departure
ticketNumber	string (13)	no	read close
close Description The ticket or document number. On the Ogone Payment Platform and the GlobalCollect Payment Platform it contains: Airline code: 3-digit airline code number Form code: A maximum of 3 digits indicating the type of document, the source of issue and the number of coupons it contains Serial number: A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits allocated to the form code and serial number shall not exceed ten TICKETNUMBER can be replaced with PNR if the ticket number is unavailable
totalFare	integer	no	read close
close Description Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets
totalFee	integer	no	read close
close Description Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
totalTaxes	integer	no	read close
close Description Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
travelAgencyName	string (25)	no	read close
close Description Name of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.
lodgingData	object	no	read close
close Description Object that holds lodging specific data SDK Object type LodgingData
charges	array of object	no	read close
close Description Object that holds lodging related charges
items	object	no	read close
close SDK Object type LodgingCharge
chargeAmount	integer (12)	no	read close
close Description Amount of additional charges associated with the stay of the guest. Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
chargeAmountCurrencyCode	string (3)	no	read close
close Description Currency for Charge amount. The code should be in 3 letter ISO format.
chargeType	string	no	read close
close Description Type of additional charges associated with the stay of the guest. Allowed values: lodging telephone restaurant minibar giftshop laundry transport gratuity conferenceRoom audiovisual banquet internet earlyDeparture roomService loungeBar other
checkInDate	string (8)	no	read close
close Description The date the guest checks into (or plans to check in to) the facility. Format: YYYYMMDD
checkOutDate	string (8)	no	read close
close Description The date the guest checks out of (or plans to check out of) the facility. Format: YYYYMMDD
folioNumber	string (25)	no	read close
close Description The Lodging Folio Number assigned to the itemized statement of charges and credits associated with this lodging stay, which can be any combination of characters and numerals defined by the Merchant or authorized Third Party Processor.
isConfirmedReservation	boolean	no	read close
close Description Indicates whether the room reservation is confirmed. true - The room reservation is confirmed false - The room reservation is not confirmed
isFacilityFireSafetyConform	boolean	no	read close
close Description Defines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation. true - The facility conform to the requirements false - The facility doesn't conform to the requirements
isNoShow	boolean	no	read close
close Description Indicate if this the customer is a no show case. In such case, the lodging property can charge a no show fee. true - The customer is a no show false - Not applicable
isPreferenceSmokingRoom	boolean	no	read close
close Description Indicated the preference of the customer for a smoking or non-smoking room. true - A smoking room is preferred false - A non-smoking room is preferred
numberOfAdults	integer (3)	no	read close
close Description The total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)
numberOfNights	integer (4)	no	read close
close Description The number of nights for the lodging stay
numberOfRooms	integer (4)	no	read close
close Description The number of rooms rented for the lodging stay
programCode	string	no	read close
close Description Code that corresponds to the category of lodging charges detailed in this message. Allowed values: lodging - (Default) Submitted charges are for lodging noShow - Submitted charges are for the failure of the guest(s) to check in for reserved a room advancedDeposit - Submitted charges are for an Advanced Deposit to reserve one or more rooms If no value is submitted the default value lodging is used.
propertyCustomerServicePhoneNumber	string (20)	no	read close
close Description The international customer service phone number of the facility
propertyPhoneNumber	string (20)	no	read close
close Description The local phone number of the facility in an international phone number format
renterName	string (26)	no	read close
close Description Name of the person or business entity charged for the reservation and/or lodging stay
rooms	array of object	no	read close
close Description Object that holds lodging related room data
items	object	no	read close
close SDK Object type LodgingRoom
dailyRoomRate	string (12)	no	read close
close Description Daily room rate exclusive of any taxes and fees Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
dailyRoomRateCurrencyCode	string (3)	no	read close
close Description Currency for Daily room rate. The code should be in 3 letter ISO format
dailyRoomTaxAmount	string (12)	no	read close
close Description Daily room tax Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
dailyRoomTaxAmountCurrencyCode	string (3)	no	read close
close Description Currency for Daily room tax. The code should be in 3 letter ISO format
numberOfNightsAtRoomRate	integer (4)	no	read close
close Description Number of nights charged at the rate in the dailyRoomRate property
roomLocation	string (10)	no	read close
close Description Location of the room within the facility, e.g. Park or Garden etc.
roomNumber	string (6)	no	read close
close Description Room number
typeOfBed	string (12)	no	read close
close Description Size of bed, e.g., king, queen, double.
typeOfRoom	string (12)	no	read close
close Description Describes the type of room, e.g., standard, deluxe, suite.
customer	object	no	read close
close Description Object containing data related to the customer SDK Object type CustomerApprovePayment
accountType	string	no	read close
close Description Type of the customer account that is used to place this order. Can have one of the following values: none - The account that was used to place the order is a guest account or no account was used at all created - The customer account was created during this transaction existing - The customer account was an already existing account prior to this transaction
references	object	no	read close
close Description Object that holds all reference properties that are linked to this transaction SDK Object type OrderReferencesApprovePayment
merchantReference	string (30)	no	read close
close Description Your (unique) reference for the transaction that you can use to reconcile our report files
Property	Type	Required	Details

Request example

SDK: Node.js

This scenario you will probably use the most

var body = {
    "directDebitPaymentMethodSpecificInput" : {
        "token" : "bfa8a7e4-4530-455a-858d-204ba2afb77e",
        "dateCollect" : "20150201"
    },
    "order" : {
        "references" : {
            "merchantReference" : "AcmeOrder0001"
        }
    },
    "amount" : 2980
};
const sdkResponse = await client.v1.payments.approve("merchantId", "paymentId", body);
// sdkResponse has the following properties:
// - status: the HTTP status code
// - body: the response body
// - isSuccess: true if the call was successful,
//              or false if the Worldline Global Collect platform returned an error response

var body = {
    "amount" : 1
};
const sdkResponse = await client.v1.payments.approve("merchantId", "paymentId", body);
// sdkResponse has the following properties:
// - status: the HTTP status code
// - body: the response body
// - isSuccess: true if the call was successful,
//              or false if the Worldline Global Collect platform returned an error response

Default scenario

Responses

Please find below an overview of the possible responses.

Response 200 - OKPaymentApprovalResponse

The capture request was processed correctly. The new state of the payment can be found in the response.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
Group cardPaymentMethodSpecificOutput	object	no	read close
close Description Object containing additional card payment method specific details SDK Object type ApprovePaymentCardPaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
voidResponseId	string	no	read close
close Description Result of the authorization reversal request Possible values are: 00 - Successful reversal 0, 8 or 11 - Reversal request submitted 5 or 55 - Reversal request declined or referred empty or 98 - The provider did not provide a response
Group mobilePaymentMethodSpecificOutput	object	no	read close
close Description Object containing additional mobile payment method specific details SDK Object type ApprovePaymentMobilePaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
voidResponseId	string	no	read close
close Description Result of the authorization reversal request Possible values are: 00 - Successful reversal 0, 8 or 11 - Reversal request submitted 5 or 55 - Reversal request declined or referred empty or 98 - The provider did not provide a response
payment	object	no	read close
close Description Object that holds the payment data SDK Object type Payment
hostedCheckoutSpecificOutput	object	no	read close
close Description Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout. SDK Object type HostedCheckoutSpecificOutput
hostedCheckoutId	string	no	read close
close Description The ID of the Hosted Checkout Session in which the payment was made.
variant	string	no	read close
close Description Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your hosted mandate pages in a controlled manner. Please note that you need to specify the ID of the variant.
id	string	no	read close
close Description Our unique payment transaction identifier.
paymentOutput	object	no	read close
close Description Object containing payment details SDK Object type PaymentOutput
amountOfMoney	object	no	read close
close Description Object containing amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
amountPaid	integer	no	read close
close Description Amount that has been paid
amountReversed	integer	no	read close
close Description Amount that has been reversed
Group bankTransferPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the bank transfer payment method details SDK Object type BankTransferPaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
cybersourceDecisionManager	object	no	read close
close Description This 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. SDK Object type CybersourceDecisionManager
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
fraudScore	integer	no	read close
close Description Result 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.
policyApplied	string	no	read close
close Description Name of the policy that was applied during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Group cardPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the card payment method details SDK Object type CardPaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
authorisationCode	string	no	read close
close Description Card Authorization code as returned by the acquirer
card	object	no	read close
close Description Object containing card details SDK Object type CardEssentials
cardNumber	string (19)	no	read close
close Description The complete credit/debit card number
cardholderName	string (51)	no	read close
close Description The card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
expiryDate	string (4)	no	read close
close Description Expiry date of the card Format: MMYY
fraudResults	object	no	read close
close Description Fraud results contained in the CardFraudResults object SDK Object type CardFraudResults
avsResult	string	no	read close
close Description Result of the Address Verification Service checks. Possible values are: A - Address (Street) matches, Zip does not B - Street address match for international transactions—Postal code not verified due to incompatible formats C - Street address and postal code not verified for international transaction due to incompatible formats D - Street address and postal code match for international transaction, cardholder name is incorrect E - AVS error F - Address does match and five digit ZIP code does match (UK only) G - Address information is unavailable; international transaction; non-AVS participant H - Billing address and postal code match, cardholder name is incorrect (Amex) I - Address information not verified for international transaction K - Cardholder name matches (Amex) L - Cardholder name and postal code match (Amex) M - Cardholder name, street address, and postal code match for international transaction N - No Match on Address (Street) or Zip O - Cardholder name and address match (Amex) P - Postal codes match for international transaction—Street address not verified due to incompatible formats Q - Billing address matches, cardholder is incorrect (Amex) R - Retry, System unavailable or Timed out S - Service not supported by issuer U - Address information is unavailable W - 9 digit Zip matches, Address (Street) does not X - Exact AVS Match Y - Address (Street) and 5 digit Zip match Z - 5 digit Zip matches, Address (Street) does not 0 - No service available
cvvResult	string	no	read close
close Description Result of the Card Verification Value checks. Possible values are: M - CVV check performed and valid value N - CVV checked and no match P - CVV check not performed, not requested S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card U - Issuer not certified for CVV2 Y - Server provider did not respond 0 - No service available
cybersourceDecisionManager	object	no	read close
close Description This 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. SDK Object type CybersourceDecisionManager
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
fraudScore	integer	no	read close
close Description Result 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.
policyApplied	string	no	read close
close Description Name of the policy that was applied during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
fraudServiceResult	string	no	read close
close Description Resulting advice of the fraud prevention checks. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted an error. Note that the fraud check was thus not performed.
fraugster	object	no	read close
close Description Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent. SDK Object type FraugsterResults
fraudInvestigationPoints	string	no	read close
close Description Result of the Fraugster check Contains the investigation points used during the evaluation
fraudScore	integer	no	read close
close Description Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
retailDecisions	object	no	read close
close Description Additional response data returned by RetailDecisions SDK Object type FraudResultsRetailDecisions
fraudCode	string	no	read close
close Description Result of the fraud service. Provides additional information about the fraud result
fraudNeural	string	no	read close
close Description Returns the raw score of the neural
fraudRCF	string	no	read close
close Description Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
initialSchemeTransactionId	string	no	read close
close Description The unique scheme transactionId of the initial transaction that was performed with SCA. Should be stored by the merchant to allow it to be submitted in future transactions.
networkTokenData	object	no	read close
close Description Object holding data that describes a network token. SDK Object type NetworkTokenData
networkToken	string	no	read close
close Description The network token alternative for the full Permanent Account Number. To receive a non-obfuscated network token please contact your account manager.
tokenExpiryDate	string	no	read close
close Description The expiry date of the network token.
tokenReferenceId	string	no	read close
close Description A 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.
networkTokenUsed	boolean	no	read close
close Description Indicates if a network token was used during the payment.
paymentAccountReference	string	no	read close
close Description A 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.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
schemeTransactionId	string	no	read close
close Description The unique scheme transactionId of this transaction. Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty.
threeDSecureResults	object	no	read close
close Description 3D Secure results object SDK Object type ThreeDSecureResults
acsTransactionId	string	no	read close
close Description Identifier of the authenticated transaction at the ACS/Issuer
appliedExemption	string	no	read close
close Description Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
authenticationAmount	object	no	read close
close Description The amount for which this transaction has been authenticated. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
cavv	string	no	read close
close Description CAVV or AVV result indicating authentication validation value
directoryServerTransactionId	string	no	read close
close Description The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
eci	string	no	read close
close Description Indicates Authentication validation results returned after AuthenticationValidation
exemptionOutput	object	no	read close
close Description Object containing exemption output SDK Object type ExemptionOutput
exemptionRaised	string	no	read close
close Description Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
exemptionRejectionReason	string	no	read close
close Description The request exemption could not be granted. The reason why is returned in this property.
exemptionRequest	string	no	read close
close Description Type of strong customer authentication (SCA) exemption requested by you for this transaction.
schemeRiskScore	integer	no	read close
close Description Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
sdkData	object	no	read close
close Description Object containing 3-D Secure in-app SDK data SDK Object type SdkDataOutput
sdkTransactionId	string	no	read close
close Description Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
threeDSecureData	object	no	read close
close Description Object containing data regarding the 3-D Secure authentication SDK Object type ThreeDSecureData
acsTransactionId	string (36)	no	read close
close Description The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
method	string	no	read close
close Description Method of authentication used for this transaction. Possible values: frictionless = The authentication went without a challenge challenged = Cardholder was challenged avs-verified = The authentication was verified by AVS other = Another issuer method was used to authenticate this transaction
utcTimestamp	string (12)	no	read close
close Description Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
threeDSecureVersion	string	no	read close
close Description The 3-D Secure version used for the authentication. This property is used in the communication with the acquirer
threeDServerTransactionId	string	no	read close
close Description The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
xid	string	no	read close
close Description Transaction ID for the Authentication
token	string	no	read close
close Description If a token was used for or created during the payment, then the ID of that token.
Group cashPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the cash payment method details SDK Object type CashPaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
cybersourceDecisionManager	object	no	read close
close Description This 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. SDK Object type CybersourceDecisionManager
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
fraudScore	integer	no	read close
close Description Result 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.
policyApplied	string	no	read close
close Description Name of the policy that was applied during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Group directDebitPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the non SEPA direct debit payment method details SDK Object type NonSepaDirectDebitPaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
cybersourceDecisionManager	object	no	read close
close Description This 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. SDK Object type CybersourceDecisionManager
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
fraudScore	integer	no	read close
close Description Result 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.
policyApplied	string	no	read close
close Description Name of the policy that was applied during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Group eInvoicePaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the e-invoice payment method details SDK Object type EInvoicePaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
cybersourceDecisionManager	object	no	read close
close Description This 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. SDK Object type CybersourceDecisionManager
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
fraudScore	integer	no	read close
close Description Result 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.
policyApplied	string	no	read close
close Description Name of the policy that was applied during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProduct9000SpecificOutput	object	yes	read close
close Description AfterPay Installments (payment product 9000) specific details SDK Object type EInvoicePaymentProduct9000SpecificOutput
installmentId	string	yes	read close
close Description The ID of the installment plan used for the payment.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Group invoicePaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the invoice payment method details SDK Object type InvoicePaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
cybersourceDecisionManager	object	no	read close
close Description This 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. SDK Object type CybersourceDecisionManager
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
fraudScore	integer	no	read close
close Description Result 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.
policyApplied	string	no	read close
close Description Name of the policy that was applied during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Group mobilePaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the mobile payment method details SDK Object type MobilePaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
authorisationCode	string	no	read close
close Description Card Authorization code as returned by the acquirer
fraudResults	object	no	read close
close Description Fraud results contained in the CardFraudResults object SDK Object type CardFraudResults
avsResult	string	no	read close
close Description Result of the Address Verification Service checks. Possible values are: A - Address (Street) matches, Zip does not B - Street address match for international transactions—Postal code not verified due to incompatible formats C - Street address and postal code not verified for international transaction due to incompatible formats D - Street address and postal code match for international transaction, cardholder name is incorrect E - AVS error F - Address does match and five digit ZIP code does match (UK only) G - Address information is unavailable; international transaction; non-AVS participant H - Billing address and postal code match, cardholder name is incorrect (Amex) I - Address information not verified for international transaction K - Cardholder name matches (Amex) L - Cardholder name and postal code match (Amex) M - Cardholder name, street address, and postal code match for international transaction N - No Match on Address (Street) or Zip O - Cardholder name and address match (Amex) P - Postal codes match for international transaction—Street address not verified due to incompatible formats Q - Billing address matches, cardholder is incorrect (Amex) R - Retry, System unavailable or Timed out S - Service not supported by issuer U - Address information is unavailable W - 9 digit Zip matches, Address (Street) does not X - Exact AVS Match Y - Address (Street) and 5 digit Zip match Z - 5 digit Zip matches, Address (Street) does not 0 - No service available
cvvResult	string	no	read close
close Description Result of the Card Verification Value checks. Possible values are: M - CVV check performed and valid value N - CVV checked and no match P - CVV check not performed, not requested S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card U - Issuer not certified for CVV2 Y - Server provider did not respond 0 - No service available
cybersourceDecisionManager	object	no	read close
close Description This 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. SDK Object type CybersourceDecisionManager
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
fraudScore	integer	no	read close
close Description Result 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.
policyApplied	string	no	read close
close Description Name of the policy that was applied during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
fraudServiceResult	string	no	read close
close Description Resulting advice of the fraud prevention checks. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted an error. Note that the fraud check was thus not performed.
fraugster	object	no	read close
close Description Results of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent. SDK Object type FraugsterResults
fraudInvestigationPoints	string	no	read close
close Description Result of the Fraugster check Contains the investigation points used during the evaluation
fraudScore	integer	no	read close
close Description Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
retailDecisions	object	no	read close
close Description Additional response data returned by RetailDecisions SDK Object type FraudResultsRetailDecisions
fraudCode	string	no	read close
close Description Result of the fraud service. Provides additional information about the fraud result
fraudNeural	string	no	read close
close Description Returns the raw score of the neural
fraudRCF	string	no	read close
close Description Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
network	string	no	read close
close Description The network that was used for the refund
paymentData	object	no	read close
close Description Object containing payment details SDK Object type MobilePaymentData
dpan	string (19)	yes	read close
close Description The obfuscated DPAN. Only the last four digits are visible.
expiryDate	string (4)	yes	read close
close Description Expiry date of the tokenized card Format: MMYY
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
threeDSecureResults	object	no	read close
close Description 3D Secure results object SDK Object type ThreeDSecureResults
acsTransactionId	string	no	read close
close Description Identifier of the authenticated transaction at the ACS/Issuer
appliedExemption	string	no	read close
close Description Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
authenticationAmount	object	no	read close
close Description The amount for which this transaction has been authenticated. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
cavv	string	no	read close
close Description CAVV or AVV result indicating authentication validation value
directoryServerTransactionId	string	no	read close
close Description The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
eci	string	no	read close
close Description Indicates Authentication validation results returned after AuthenticationValidation
exemptionOutput	object	no	read close
close Description Object containing exemption output SDK Object type ExemptionOutput
exemptionRaised	string	no	read close
close Description Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
exemptionRejectionReason	string	no	read close
close Description The request exemption could not be granted. The reason why is returned in this property.
exemptionRequest	string	no	read close
close Description Type of strong customer authentication (SCA) exemption requested by you for this transaction.
schemeRiskScore	integer	no	read close
close Description Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
sdkData	object	no	read close
close Description Object containing 3-D Secure in-app SDK data SDK Object type SdkDataOutput
sdkTransactionId	string	no	read close
close Description Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
threeDSecureData	object	no	read close
close Description Object containing data regarding the 3-D Secure authentication SDK Object type ThreeDSecureData
acsTransactionId	string (36)	no	read close
close Description The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
method	string	no	read close
close Description Method of authentication used for this transaction. Possible values: frictionless = The authentication went without a challenge challenged = Cardholder was challenged avs-verified = The authentication was verified by AVS other = Another issuer method was used to authenticate this transaction
utcTimestamp	string (12)	no	read close
close Description Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
threeDSecureVersion	string	no	read close
close Description The 3-D Secure version used for the authentication. This property is used in the communication with the acquirer
threeDServerTransactionId	string	no	read close
close Description The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
xid	string	no	read close
close Description Transaction ID for the Authentication
Group redirectPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the redirect payment product details SDK Object type RedirectPaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
bankAccountBban	object	no	read close
close Description Object that holds the Basic Bank Account Number (BBAN) data SDK Object type BankAccountBban
accountHolderName	string (30)	depends	read close
close Description Name of the account holder Depends on: Required for Create and Update token calls for ACH (730).
accountNumber	string	depends	read close
close Description Bank account number Depends on: Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value. Required for Create and Update token calls.
bankCode	string	depends	read close
close Description Bank code Depends on: Required for Direct Debit UK (705) and ACH (730) payments, except when a token has been included in the request that includes this value. Required for Create and Update token calls for ACH (730).
bankName	string (40)	no	read close
close Description Name of the bank
branchCode	string	no	read close
close Description Branch code
checkDigit	string	no	read close
close Description Bank check digit
countryCode	string (2)	no	read close
close Description ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
bankAccountIban	object	no	read close
close Description Object containing account holder name and IBAN information SDK Object type BankAccountIban
accountHolderName	string (30)	depends	read close
close Description Name in which the account is held. Depends on: Required for the creation of a Payout Required for Create and Update token calls.
iban	string (50)	depends	read close
close Description The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits. Depends on: Required for the creation of a Payout Required for Create and Update token. Required for payments with product 9000 (AfterPay Installments) in Austria (AT) and Germany (DE). Required for Create mandate and Create payment with mandate calls
bic	string	no	read close
close Description The BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
cybersourceDecisionManager	object	no	read close
close Description This 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. SDK Object type CybersourceDecisionManager
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
fraudScore	integer	no	read close
close Description Result 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.
policyApplied	string	no	read close
close Description Name of the policy that was applied during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
Group paymentProduct3201SpecificOutput	object	no	read close
close Description PostFinance Card (payment product 3201) specific details SDK Object type PaymentProduct3201SpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
card	object	no	read close
close Description Object containing card details SDK Object type CardEssentials
cardNumber	string (19)	no	read close
close Description The complete credit/debit card number
cardholderName	string (51)	no	read close
close Description The card holder's name on the card. Minimum length of 2, maximum length of 51 characters.
expiryDate	string (4)	no	read close
close Description Expiry date of the card Format: MMYY
Group paymentProduct806SpecificOutput	object	no	read close
close Description Trustly (payment product 806) specific details SDK Object type PaymentProduct806SpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
billingAddress	object	no	read close
close Description Object containing the billing address details of the customer SDK Object type Address
additionalInfo	string (50)	no	read close
close Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705) except when a token has been included in the request that includes this value Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
customerAccount	object	no	read close
close Description Object containing the account details SDK Object type TrustlyBankAccount
accountLastDigits	string	no	read close
close Description The last digits of the account number
bankName	string	no	read close
close Description The name of the bank
clearinghouse	string	no	read close
close Description The country of the clearing house
personIdentificationNumber	string	no	read close
close Description The ID number of the account holder
Group paymentProduct836SpecificOutput	object	no	read close
close Description Sofort (payment product 836) specific details SDK Object type PaymentProduct836SpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
securityIndicator	string	no	read close
close Description Indicates if SofortBank could estabilish if the transaction could successfully be processed. 0 - You should wait for the transaction to be reported as paid before shipping any goods. 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.
Group paymentProduct840SpecificOutput	object	no	read close
close Description PayPal (payment product 840) specific details SDK Object type PaymentProduct840SpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
billingAddress	object	no	read close
close Description Object containing the billing address details of the customer SDK Object type Address
additionalInfo	string (50)	no	read close
close Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705) except when a token has been included in the request that includes this value Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
customerAccount	object	no	read close
close Description Object containing the details of the PayPal account SDK Object type PaymentProduct840CustomerAccount
accountId	string	no	read close
close Description Username with which the PayPal account holder has registered at PayPal
billingAgreementId	string	no	read close
close Description Identification of the PayPal recurring billing agreement
companyName	string	no	read close
close Description Name of the company in case the PayPal account is owned by a business
contactPhone	string	no	read close
close Description The phone number of the PayPal account holder
countryCode	string	no	read close
close Description Country where the PayPal account is located
customerAccountStatus	string	no	read close
close Description Status of the PayPal account. Possible values are: verified - PayPal has verified the funding means for this account unverified - PayPal has not verified the funding means for this account
customerAddressStatus	string	no	read close
close Description Status of the customer's shipping address as registered by PayPal Possible values are: none - Status is unknown at PayPal confirmed - The address has been confirmed unconfirmed - The address has not been confirmed
firstName	string	no	read close
close Description First name of the PayPal account holder
payerId	string	no	read close
close Description The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
surname	string	no	read close
close Description Surname of the PayPal account holder
customerAddress	object	no	read close
close Description Object containing the address details of the customer SDK Object type Address
additionalInfo	string (50)	no	read close
close Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705) except when a token has been included in the request that includes this value Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
protectionEligibility	object	no	read close
close Description Protection Eligibility data of the PayPal customer SDK Object type ProtectionEligibility
eligibility	string	no	read close
close Description Possible values: Eligible PartiallyEligible Ineligible
type	string	no	read close
close Description Possible values: ItemNotReceivedEligible UnauthorizedPaymentEligible Ineligible
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
token	string	no	read close
close Description ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
Group sepaDirectDebitPaymentMethodSpecificOutput	object	one of the group	read close
close Description Object containing the SEPA direct debit details SDK Object type SepaDirectDebitPaymentMethodSpecificOutput Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
fraudResults	object	no	read close
close Description Object containing the results of the fraud screening SDK Object type FraudResults
cybersourceDecisionManager	object	no	read close
close Description This 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. SDK Object type CybersourceDecisionManager
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
fraudScore	integer	no	read close
close Description Result 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.
policyApplied	string	no	read close
close Description Name of the policy that was applied during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
fraudServiceResult	string	no	read close
close Description Results from the fraud prevention check. Possible values are: accepted - Based on the checks performed the transaction can be accepted challenged - Based on the checks performed the transaction should be manually reviewed denied - Based on the checks performed the transaction should be rejected no-advice - No fraud check was requested/performed error - The fraud check resulted in an error and the fraud check was thus not performed
inAuth	object	no	read close
close Description Object containing device fingerprinting details from InAuth SDK Object type InAuth
deviceCategory	string	no	read close
close Description The type of device used by the customer. Example values: SMARTPHONE PERSONAL_COMPUTER TABLET WEARABLE_COMPUTER GAME_CONSOLE SMART_TV PDA OTHER UNKNOWN
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
riskScore	string	no	read close
close Description The score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
trueIpAddress	string	no	read close
close Description The true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
trueIpAddressCountry	string	no	read close
close Description The country of the customer based on the location of the True IP Address determined by inAuth.
microsoftFraudProtection	object	no	read close
close Description This object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service. SDK Object type MicrosoftFraudResults
clauseName	string	no	read close
close Description Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
deviceCountryCode	string	no	read close
close Description The country of the customer determined by Microsoft Device Fingerprinting.
deviceId	string	no	read close
close Description This is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
fraudScore	integer	no	read close
close Description Result of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
policyApplied	string	no	read close
close Description Name of the policy that was applied on during the evaluation of this transaction.
reasonCodes	array	no	read close
close Description List of one or more reason codes.
trueIpAddress	string	no	read close
close Description The true IP address as determined by Microsoft Device Fingerprinting.
userDeviceType	string	no	read close
close Description The type of device used by the customer.
paymentProduct771SpecificOutput	object	yes	read close
close Description Output that is SEPA Direct Debit specific (i.e. the used mandate) SDK Object type PaymentProduct771SpecificOutput
mandateReference	string	no	read close
close Description Unique reference to a Mandate
paymentProductId	integer	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
token	string	no	read close
close Description ID of the token. This property is populated for the GlobalCollect payment platform when the payment was done with a token or when the payment was tokenized.
paymentMethod	string	no	read close
close Description Payment method identifier used by the our payment engine with the following possible values: bankRefund bankTransfer card cash directDebit eInvoice invoice redirect
references	object	no	read close
close Description Object that holds all reference properties that are linked to this transaction SDK Object type PaymentReferences
merchantOrderId	integer	no	read close
close Description Your order ID for this transaction that is also returned in our report files
merchantReference	string	no	read close
close Description Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
paymentReference	string	no	read close
close Description Payment Reference generated by WebCollect
providerId	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
providerMerchantId	string	no	read close
close Description Provides an additional means of reconciliation, this is the MerchantId used at the provider
providerReference	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
referenceOrigPayment	string	no	read close
close Description When you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
reversalReason	string	no	read close
close Description The reason description given for the reversedAmount property.
status	enum	no	read close
close Description Current high-level status of the payment in a human-readable form. Possible values are : ACCOUNT_VERIFIED - The account has been verified using a validation services like 0$ auth CREATED - The transaction has been created. This is the initial state once a new payment is created. REDIRECTED - The customer has been redirected to a 3rd party to complete the authentication/payment PENDING_PAYMENT - Instructions have been provided and we are now waiting for the money to come in PENDING_FRAUD_APPROVAL - The transaction has been marked for manual review after an automatic fraud screening PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the capturing of the funds PENDING_COMPLETION - The transaction needs to be completed. PENDING_CAPTURE - The transaction is waiting for you to request one or more captures of the funds. REJECTED - The transaction has been rejected AUTHORIZATION_REQUESTED - we have requested an authorization against an asynchronous system and is awaiting its response CAPTURE_REQUESTED - The transaction is in the queue to be captured CAPTURED - The transaction has been captured and we have received online confirmation PAID - We have matched the incoming funds to the transaction CANCELLED - You have cancelled the transaction REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request REVERSED - The transaction has been reversed CHARGEBACK_NOTIFICATION - We have received a notification of chargeback and this status informs you that your account will be debited for a particular transaction CHARGEBACKED - The transaction has been chargebacked REFUNDED - The transaction has been refunded Please see Statuses for a full overview of possible values.
statusOutput	object	no	read close
close Description This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed. SDK Object type PaymentStatusOutput
errors	array of object	no	read close
close Description Custom object contains the set of errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
close Description Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform. PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform. IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
close Description Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
propertyName	string	no	read close
close Description Returned only if the error relates to a value that was missing or incorrect. Contains a location path to the value as a JSonata query. Some common examples: a.b selects the value of property b of root property a, a[1] selects the first element of the array in root property a, a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes
isAuthorized	boolean	no	read close
close Description Indicates if the transaction has been authorized true false
isCancellable	boolean	no	read close
close Description Flag indicating if the payment can be cancelled true false
isRefundable	boolean	no	read close
close Description Flag indicating if the payment can be refunded true false
isRetriable	boolean	no	read close
close Description Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee true false
providerRawOutput	array of object	no	read close
close Description This is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
items	object	no	read close
close SDK Object type KeyValuePair
key	string	no	read close
close Description Name of the key or property
value	string	no	read close
close Description Value of the key or property
statusCategory	enum	no	read close
close Description Highlevel status of the payment, payout or refund with the following possible values: CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses: CREATED PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses: PENDING_PAYMENT REDIRECTED ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses: ACCOUNT_VERIFIED PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses: PENDING_APPROVAL PENDING_COMPLETION PENDING_CAPTURE PENDING_FRAUD_APPROVAL PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses: AUTHORIZATION_REQUESTED CAPTURE_REQUESTED PAYOUT_REQUESTED REFUND_REQUESTED COMPLETED: The transaction has completed. This category groups the following statuses: CAPTURED PAID ACCOUNT_CREDITED CHARGEBACK_NOTIFICATION REVERSED: The transaction has been reversed. This category groups the following statuses: CHARGEBACKED REVERSED REFUNDED: The transaction has been refunded. This category groups the following statuses: REFUNDED UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses: CANCELLED REJECTED REJECTED_CAPTURE REJECTED_CREDIT Please see Statuses for a full overview of possible values.
statusCode	integer	no	read close
close Description Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
statusCodeChangeDateTime	string	no	read close
close Description Date and time of payment Format: YYYYMMDDHH24MISS
threeDSecureStatus	enum	no	read close
close Description The 3D Secure status, with the following possible values: ENROLLED: the card is enrolled for 3D Secure authentication. The customer can be redirected to a 3D Secure access control server (ACS) NOT_ENROLLED: the card is not enrolled for 3D Secure authentication INVALID_PARES_OR_NOT_COMPLETED: the PARes is invalid, or the customer did not complete the 3D Secure authentication AUTHENTICATED: the customer has passed the 3D Secure authentication NOT_AUTHENTICATED: the customer failed the 3D Secure authentication NOT_PARTICIPATING: the cardholder has not set up their card for 2-step 3D Secure. Note that this status will only be set for payments that make use of 2-step 3D Secure.
paymentMethodSpecificOutput	object	no	read close
close Deprecated: Use cardPaymentMethodSpecificOutput instead Description Object containing additional payment method specific details Deprecated: this property does not support different outputs for payment methods other than cards. Please use cardPaymentMethodSpecificOutput instead. SDK Object type ApprovePaymentCardPaymentMethodSpecificOutput
voidResponseId	string	no	read close
close Deprecated Description Result of the authorization reversal request Possible values are: 00 - Successful reversal 0, 8 or 11 - Reversal request submitted 5 or 55 - Reversal request declined or referred empty or 98 - The provider did not provide a response
Property	Type	Required	Details

Response example

SDK: Node.js

This scenario you will probably use the most

{
    "payment" : {
        "id" : "000000891500000237080000200001",
        "paymentOutput" : {
            "amountOfMoney" : {
                "amount" : 2890,
                "currencyCode" : "EUR"
            },
            "references" : {
                "paymentReference" : "0"
            },
            "paymentMethod" : "card",
            "cardPaymentMethodSpecificOutput" : {
                "paymentProductId" : 1,
                "authorisationCode" : "123456",
                "card" : {
                    "cardNumber" : "************7977",
                    "expiryDate" : "1299"
                },
                "fraudResults" : {
                    "avsResult" : "0",
                    "cvvResult" : "M",
                    "fraudServiceResult" : "no-advice"
                },
                "threeDSecureResults" : {
                    "authenticationAmount" : {
                        "currencyCode" : "EUR",
                        "amount" : 2890
                    }
                }
            }
        },
        "status" : "CAPTURE_REQUESTED",
        "statusOutput" : {
            "isCancellable" : true,
            "statusCode" : 800,
            "statusCodeChangeDateTime" : "20140627140735",
            "isAuthorized" : true
        }
    }
}

Default scenario

Response 400 - Bad requestErrorResponse

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
close Description Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform. PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform. IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
close Description Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
propertyName	string	no	read close
close Description Returned only if the error relates to a value that was missing or incorrect. Contains a location path to the value as a JSonata query. Some common examples: a.b selects the value of property b of root property a, a[1] selects the first element of the array in root property a, a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes
Property	Type	Required	Details

Response example

SDK: Node.js

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

Default scenario

Response 402 - Payment requiredErrorResponse

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
close Description Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform. PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform. IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
close Description Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
propertyName	string	no	read close
close Description Returned only if the error relates to a value that was missing or incorrect. Contains a location path to the value as a JSonata query. Some common examples: a.b selects the value of property b of root property a, a[1] selects the first element of the array in root property a, a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes
Property	Type	Required	Details

Response example

SDK: Node.js

This scenario you will probably use the most

{
    "errorId" : "1105db54-9c91-4a97-baa7-3c4182458047",
    "errors" : [
        {
            "code" : "410110",
            "requestId" : "3927859",
            "message" : "UNKNOWN ORDER OR NOT PENDING"
        }
    ]
}

Default scenario

Response 404 - Not foundErrorResponse

The payment you are trying to approve can't be found.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
close Description Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform. PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform. IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
close Description Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
propertyName	string	no	read close
close Description Returned only if the error relates to a value that was missing or incorrect. Contains a location path to the value as a JSonata query. Some common examples: a.b selects the value of property b of root property a, a[1] selects the first element of the array in root property a, a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes
Property	Type	Required	Details

Response example

SDK: Node.js

This scenario you will probably use the most

{
    "errorId" : "657b10da-d2f9-4088-a948-bf190ef516b1-00000213",
    "errors" : [
        {
            "code" : "300240",
            "message" : "GET_ORDERSTATUS_ORDER_NOT_FOUND"
        }
    ]
}

Default scenario

Approve payment

Payments

Request

PayloadApprovePaymentRequest

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Depends on:

Description

Depends on:

Depends on:

Description

Description

Depends on:

Depends on:

Description

Description

Description

Description

Description

Depends on:

Depends on:

Description

Depends on:

Description

Description

Description

Description

Description

Description

Depends on:

Description

Description

Depends on:

Depends on:

Description

Description

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Depends on:

Description

Description

Description

Description

Description

Description

Description

Depends on:

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description