This site requires javascript to be enabled.

  • Search AI-powered

Results for

xxx

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

Properties
Property Type Required Details
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)
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.

close

Description

The desired date for the collection
Format: YYYYMMDD
close

Description

Token containing tokenized bank account details
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.

close

Description

The desired date for the collection
Format: YYYYMMDD
close

Description

Token containing tokenized bank account details
close

Description

Object that holds the order data
  • SDK Object type
    OrderApprovePayment
close

Description

Object containing additional input on the order
  • SDK Object type
    AdditionalOrderInputAirlineData
close

Description

Object that holds airline specific data
  • SDK Object type
    AirlineData
close

Description

Numeric code identifying the agent
close

Description

Airline numeric code
close

Description

Date of the Flight
Format: YYYYMMDD
close

Description

Object that holds the data on the individual legs of the ticket
close
  • SDK Object type
    AirlineFlightLeg
close

Description

Reservation Booking Designator
close

Description

Arrival airport/city code
close

Description

The arrival time in the local time zone
Format: HH:MM
close

Description

IATA carrier code
close

Description

Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
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
close

Description

Date of the leg
Format: YYYYMMDD
close

Description

The departure time in the local time at the departure airport
Format: HH:MM
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
close

Description

New ticket number that is issued when a ticket is exchanged
close

Description

Fare of this leg
close

Description

Fare Basis/Ticket Designator
close

Description

Fee for this leg of the trip
close

Description

The flight number assigned by the airline carrier with no leading spaces
Should be a numeric string
close

Description

Sequence number of the flight leg
close

Description

Origin airport/city code
close

Description

PassengerClass if this leg
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
close

Description

Possible values are:
  • permitted = Stopover permitted
  • non-permitted = Stopover not permitted
close

Description

Taxes for this leg of the trip
close

Description

Airline tracing number
close

Description

  • true = The ticket is an E-Ticket
  • false = the ticket is not an E-Ticket
close
Deprecated: Use order.customer.accountType instead

Description

  • true = a registered known customer
  • false = unknown customer
close

Description

  • true - Restricted, the ticket is non-refundable
  • false - No restrictions, the ticket is (partially) refundable
close

Description

  • true - The payer is the ticket holder
  • false - The payer is not the ticket holder
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
close

Description

Your ID of the customer in the context of the airline data
close

Description

Name of the airline
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.
close

Description

Name of passenger
close

Description

Object that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
close
  • SDK Object type
    AirlinePassenger
close

Description

First name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Surname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Surname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Title of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Place of issue
For sales in the US the last two characters (pos 14-15) must be the US state code.
close

Description

Passenger name record
close

Description

IATA point of sale name
close

Description

city code of the point of sale
close

Description

Possible values:
  • e-ticket
  • city-ticket-office
  • airport-ticket-office
  • ticket-by-mail
  • ticket-on-departure
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
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
close

Description

Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
close

Description

Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
close

Description

Name of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.
close

Description

Object that holds lodging specific data
  • SDK Object type
    LodgingData
close

Description

Object that holds lodging related charges
close
  • SDK Object type
    LodgingCharge
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.
close

Description

Currency for Charge amount. The code should be in 3 letter ISO format.
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
close

Description

The date the guest checks into (or plans to check in to) the facility.
Format: YYYYMMDD
close

Description

The date the guest checks out of (or plans to check out of) the facility.
Format: YYYYMMDD
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.
close

Description

Indicates whether the room reservation is confirmed.
  • true - The room reservation is confirmed
  • false - The room reservation is not confirmed
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
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
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
close

Description

The total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)
close

Description

The number of nights for the lodging stay
close

Description

The number of rooms rented for the lodging stay
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.
close

Description

The international customer service phone number of the facility
close

Description

The local phone number of the facility in an international phone number format
close

Description

Name of the person or business entity charged for the reservation and/or lodging stay
close

Description

Object that holds lodging related room data
close
  • SDK Object type
    LodgingRoom
close

Description

Daily room rate exclusive of any taxes and fees
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
close

Description

Currency for Daily room rate. The code should be in 3 letter ISO format
close

Description

Daily room tax
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
close

Description

Currency for Daily room tax. The code should be in 3 letter ISO format
close

Description

Number of nights charged at the rate in the dailyRoomRate property
close

Description

Location of the room within the facility, e.g. Park or Garden etc.
close

Description

Room number
close

Description

Size of bed, e.g., king, queen, double.
close

Description

Describes the type of room, e.g., standard, deluxe, suite.
close

Description

Object containing data related to the customer
  • SDK Object type
    CustomerApprovePayment
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
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    OrderReferencesApprovePayment
close

Description

Your (unique) reference for the transaction that you can use to reconcile our report files

Request example

SDK: Python

This scenario you will probably use the most

  • direct_debit_payment_method_specific_input = ApprovePaymentNonSepaDirectDebitPaymentMethodSpecificInput()
    direct_debit_payment_method_specific_input.date_collect = '20150201'
    direct_debit_payment_method_specific_input.token = 'bfa8a7e4-4530-455a-858d-204ba2afb77e'
    
    references = OrderReferencesApprovePayment()
    references.merchant_reference = 'AcmeOrder0001'
    
    order = OrderApprovePayment()
    order.references = references
    
    body = ApprovePaymentRequest()
    body.amount = 2980
    body.direct_debit_payment_method_specific_input = direct_debit_payment_method_specific_input
    body.order = order
    
    response = client.v1().merchant('merchantId').payments().approve('paymentId', body)
    
  • body = ApprovePaymentRequest()
    body.amount = 1
    
    response = client.v1().merchant('merchantId').payments().approve('paymentId', body)
    

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.

Properties
Property Type Required Details
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.

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
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.

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
close

Description

Object that holds the payment data
  • SDK Object type
    Payment
close

Description

Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout.
  • SDK Object type
    HostedCheckoutSpecificOutput
close

Description

The ID of the Hosted Checkout Session in which the payment was made.
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.
close

Description

Our unique payment transaction identifier.
close

Description

Object containing payment details
  • SDK Object type
    PaymentOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Amount that has been paid
close

Description

Amount that has been reversed
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.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
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
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
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
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.
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.
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.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
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
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
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.
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.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
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
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
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.
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
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
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
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.
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.
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.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
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
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
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.
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.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
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.
close

Description

Indicates if a network token was used during the payment.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
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)
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
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
close

Description

If a token was used for or created during the payment, then the ID of that token.
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.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
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
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
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
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.
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.
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.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
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
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
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.
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.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
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
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
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
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.
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.
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.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
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
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
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.
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.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
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
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
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
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.
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.
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.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
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
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
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.
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.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

AfterPay Installments (payment product 9000) specific details
  • SDK Object type
    EInvoicePaymentProduct9000SpecificOutput
close

Description

The ID of the installment plan used for the payment.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
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
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
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
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.
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.
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.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
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
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
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.
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.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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.

close

Description

Card Authorization code as returned by the acquirer
close

Description

Fraud results contained in the CardFraudResults object
  • SDK Object type
    CardFraudResults
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
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
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.
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
close

Description

Result of the Fraugster check Contains the investigation points used during the evaluation
close

Description

Result of the Fraugster check Contains the overall Fraud score which is an integer between 0 and 99
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
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
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.
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.
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.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
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
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
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.
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.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Additional response data returned by RetailDecisions
  • SDK Object type
    FraudResultsRetailDecisions
close

Description

Result of the fraud service. Provides additional information about the fraud result
close

Description

Returns the raw score of the neural
close

Description

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction
close

Description

The network that was used for the refund
close

Description

Object containing payment details
  • SDK Object type
    MobilePaymentData
close

Description

The obfuscated DPAN. Only the last four digits are visible.
close

Description

Expiry date of the tokenized card
Format: MMYY
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

3D Secure results object
  • SDK Object type
    ThreeDSecureResults
close

Description

Identifier of the authenticated transaction at the ACS/Issuer
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format)
close

Description

The amount for which this transaction has been authenticated.
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

CAVV or AVV result indicating authentication validation value
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Indicates Authentication validation results returned after AuthenticationValidation
close

Description

Object containing exemption output
  • SDK Object type
    ExemptionOutput
close

Description

Type of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
close

Description

The request exemption could not be granted. The reason why is returned in this property.
close

Description

Type of strong customer authentication (SCA) exemption requested by you for this transaction.
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataOutput
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
close

Description

Object containing data regarding the 3-D Secure authentication
  • SDK Object type
    ThreeDSecureData
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)
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
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

The 3-D Secure version used for the authentication.

This property is used in the communication with the acquirer

close

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

Transaction ID for the Authentication
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.

close

Description

Object that holds the Basic Bank Account Number (BBAN) data
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
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.
close

Description

Object containing account holder name and IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
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.
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.
close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
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
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
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
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.
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.
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.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
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
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
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.
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.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
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.

close

Description

Object containing card details
  • SDK Object type
    CardEssentials
close

Description

The complete credit/debit card number
close

Description

The card holder's name on the card.
close

Description

Expiry date of the card
Format: MMYY
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.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
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
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
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
close

Description

Full name of the state or province
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
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the account details
  • SDK Object type
    TrustlyBankAccount
close

Description

The last digits of the account number
close

Description

The name of the bank
close

Description

The country of the clearing house
close

Description

The ID number of the account holder
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.

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.
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.

close

Description

Object containing the billing address details of the customer
  • SDK Object type
    Address
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
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
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
close

Description

Full name of the state or province
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
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing the details of the PayPal account
  • SDK Object type
    PaymentProduct840CustomerAccount
close

Description

Username with which the PayPal account holder has registered at PayPal
close

Description

Identification of the PayPal recurring billing agreement
close

Description

Name of the company in case the PayPal account is owned by a business
close

Description

The phone number of the PayPal account holder
close

Description

Country where the PayPal account is located
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
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
close

Description

First name of the PayPal account holder
close

Description

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
close

Description

Surname of the PayPal account holder
close

Description

Object containing the address details of the customer
  • SDK Object type
    Address
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
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
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
close

Description

Full name of the state or province
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
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Protection Eligibility data of the PayPal customer
  • SDK Object type
    ProtectionEligibility
close

Description

Possible values:
  • Eligible
  • PartiallyEligible
  • Ineligible
close

Description

Possible values:
  • ItemNotReceivedEligible
  • UnauthorizedPaymentEligible
  • Ineligible
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
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.

close

Description

Object containing the results of the fraud screening
  • SDK Object type
    FraudResults
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
close

Description

Object containing device fingerprinting details from InAuth
  • SDK Object type
    InAuth
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
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.
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.
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.
close

Description

The country of the customer based on the location of the True IP Address determined by inAuth.
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
close

Description

Name of the clause within the applied policy that was triggered during the evaluation of this transaction.
close

Description

The country of the customer determined by Microsoft Device Fingerprinting.
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.
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.
close

Description

Name of the policy that was applied on during the evaluation of this transaction.
close

Description

The true IP address as determined by Microsoft Device Fingerprinting.
close

Description

The type of device used by the customer.
close

Description

Output that is SEPA Direct Debit specific (i.e. the used mandate)
  • SDK Object type
    PaymentProduct771SpecificOutput
close

Description

Unique reference to a Mandate
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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.
close

Description

Payment method identifier used by the our payment engine with the following possible values:
  • bankRefund
  • bankTransfer
  • card
  • cash
  • directDebit
  • eInvoice
  • invoice
  • redirect
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    PaymentReferences
close

Description

Your order ID for this transaction that is also returned in our report files
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.
close

Description

Payment Reference generated by WebCollect
close

Description

Provides an additional means of reconciliation for Gateway merchants
close

Description

Provides an additional means of reconciliation, this is the MerchantId used at the provider
close

Description

Provides an additional means of reconciliation for Gateway merchants
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
close

Description

The reason description given for the reversedAmount property.
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.
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
close

Description

Custom object contains the set of errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
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.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
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
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'.
close

Description

ID of the request that can be used for debugging purposes
close

Description

Indicates if the transaction has been authorized
  • true
  • false
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
close

Description

Flag indicating if the payment can be refunded
  • true
  • false
close

Description

Flag indicating whether a rejected payment may be retried by the merchant without incurring a fee
  • true
  • false
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.
close
  • SDK Object type
    KeyValuePair
close

Description

Name of the key or property
close

Description

Value of the key or property
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.
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.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS
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.
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
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

Response example

SDK: Python

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

Response 400 - Bad requestErrorResponse

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
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.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
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
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'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Python

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

Response 402 - Payment requiredErrorResponse

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
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.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
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
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'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Python

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

Response 404 - Not foundErrorResponse

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

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
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.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
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
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'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Python

This scenario you will probably use the most

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