This site requires javascript to be enabled.

Results for

xxx

Get capture

GET https://{domainname}/v1/{merchantId}/captures/{captureId}

Captures

The captures REST services allow you to retrieve details of a capture created through the capture payment API. A capture is identified by its captureId.

Request

Retrieves the details of the capture with the captureId provided in the URL. This captureId was returned to you with the capture payment request. The request does not have any additional input parameters.

Request example

SDK: .NET

This scenario you will probably use the most

  • CaptureResponse response = await client.Merchant("merchantId").Captures().Get("captureId");
    

Responses

Please find below an overview of the possible responses.

Response 200 - OKCaptureResponse

An HTTP 200 response is returned with the details of the captures if the retrieval is successful.

Properties
Property Type Required Details
close

Description

Object containing capture details
  • SDK Object type
    CaptureOutput
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

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

Our unique capture transaction identifier.
close

Description

Current high-level status of the captures in a human-readable form. Possible values are :
  • CAPTURE_REQUESTED - The transaction is in the queue to be captured
  • CAPTURED - The transaction has been captured and we have received online confirmation
  • CANCELLED - You have cancelled the capture
  • REJECTED_CAPTURE - The capture has been rejected
  • REVERSED - The capture has been reversed

Please see Statuses for a full overview of possible values.
close

Description

This object has the numeric representation of the current capture status, timestamp of last status change and performable action on the current capture resource. In case of failed captures and negative scenarios, detailed error information is listed.
  • SDK Object type
    CaptureStatusOutput
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

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.

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "id" : "000000000100000000010000100001",
        "captureOutput" : {
            "amountOfMoney" : {
                "amount" : 100,
                "currencyCode" : "EUR"
            },
            "references" : {
                "merchantReference" : "AcmeOrder0001",
                "paymentReference" : "0"
            },
            "paymentMethod" : "card",
            "cardPaymentMethodSpecificOutput" : {
                "paymentProductId" : 1,
                "authorisationCode" : "726747",
                "card" : {
                    "cardNumber" : "************7977",
                    "expiryDate" : "1299"
                },
                "fraudResults" : {
                    "avsResult" : "0",
                    "cvvResult" : "0",
                    "fraudServiceResult" : "no-advice"
                },
                "threeDSecureResults" : {
                    "authenticationAmount" : {
                        "currencyCode" : "EUR",
                        "amount" : 100
                    }
                }
            }
        },
        "status" : "CAPTURE_REQUESTED",
        "statusOutput" : {
            "statusCode" : 91
        }
    }