Capture payment
Payments
The payments REST services allow you to initiate a payment, retrieve the payment details or perform specific actions like refunding or requesting capture of a payment. A payment is identified by its paymentId. Some payment products allow a two step approach allowing you to control when the authorization takes place separate from when the funds are actually captured.
Request
When you want to capture the funds on a payment with a PENDING_CAPTURE state you can call this API. This API allows multiple, partial captures of the authorized funds. Depending on the payment product and the 3rd party used to process the payment this might be done in real-time or in more off-line, batch-like fashion.
If the created payment requires approval then it will require this step before the funds are actually captured.
PENDING_CAPTURE is only a common status with card transactions. You can specify the amount you would like to be captured in case you want to capture a lower amount than the authorized amount.
Payloaddomain.CapturePaymentRequest
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
amount | integer (12) | no | read close |
close
DescriptionHere you can specify the amount that you want to capture (specified in cents, where single digit currencies are presumed to have 2 digits).
The amount can be lower than the amount that was authorized, but not higher. If left empty, the full amount will be captured and the request will be final. If the full amount is captured, the request will also be final. |
|||
isFinal | boolean | no | read close |
close
DescriptionThis property indicates whether this will be the final capture of this transaction.
The default value for this property is false.
|
Request example
This scenario you will probably use the most
-
// Assigning literals to pointer variables directly is not supported. // The below code uses helper function connectsdk.NewInt64 to overcome this issue. // This helper function is provided by the SDK's root package. // http://stackoverflow.com/a/30716481 lists a few more alternatives. var body domain.CapturePaymentRequest body.Amount = connectsdk.NewInt64(2980) response, err := client.V1().Merchant("merchantId").Payments().Capture("paymentId", body, nil)
Responses
Please find below an overview of the possible responses.
Response 201 - Createddomain.CaptureResponse
The capture request was processed correctly. The new state of the payment can be found in the response.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
object | no | read close | |
object | no | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
amountPaid | integer | no | read close |
close
DescriptionAmount that has been paid
|
|||
amountReversed | integer | no | read close |
close
DescriptionAmount that has been reversed
|
|||
object | one of the group | read close | |
close
DescriptionObject containing the bank transfer payment method details
|
|||
object | no | read close | |
close
DescriptionObject containing the results of the fraud screening
|
|||
fraudServiceResult | string | no | read close |
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
object | no | read close | |
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
deviceCategory | string | no | read close |
close
DescriptionThe type of device used by the customer. Example values:
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
riskScore | string | no | read close |
close
DescriptionThe score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
|
|||
trueIpAddressCountry | string | no | read close |
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
object | no | read close | |
close
DescriptionThis object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
|
|||
clauseName | string | no | read close |
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
deviceCountryCode | string | no | read close |
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
policyApplied | string | no | read close |
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
userDeviceType | string | no | read close |
close
DescriptionThe type of device used by the customer.
|
|||
paymentProductId | integer | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
object | one of the group | read close | |
close
DescriptionObject containing the card payment method details
|
|||
authorisationCode | string | no | read close |
close
DescriptionCard Authorization code as returned by the acquirer
|
|||
object | no | read close | |
cardNumber | string (19) | no | read close |
close
DescriptionThe complete credit/debit card number
|
|||
cardholderName | string | no | read close |
close
DescriptionThe card holder's name on the card.
|
|||
expiryDate | string (4) | no | read close |
close
DescriptionExpiry date of the card
Format: MMYY |
|||
object | no | read close | |
close
DescriptionFraud results contained in the CardFraudResults object
|
|||
avsResult | string | no | read close |
close
DescriptionResult of the Address Verification Service checks. Possible values are:
|
|||
cvvResult | string | no | read close |
close
DescriptionResult of the Card Verification Value checks. Possible values are:
|
|||
fraudServiceResult | string | no | read close |
close
DescriptionResulting advice of the fraud prevention checks. Possible values are:
|
|||
object | no | read close | |
close
DescriptionResults of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
|
|||
fraudInvestigationPoints | string | no | read close |
close
DescriptionResult of the Fraugster check
Contains the investigation points used during the evaluation
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Fraugster check
Contains the overall Fraud score which is an integer between 0 and 99
|
|||
object | no | read close | |
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
deviceCategory | string | no | read close |
close
DescriptionThe type of device used by the customer. Example values:
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
riskScore | string | no | read close |
close
DescriptionThe score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
|
|||
trueIpAddressCountry | string | no | read close |
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
object | no | read close | |
close
DescriptionThis object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
|
|||
clauseName | string | no | read close |
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
deviceCountryCode | string | no | read close |
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
policyApplied | string | no | read close |
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
userDeviceType | string | no | read close |
close
DescriptionThe type of device used by the customer.
|
|||
object | no | read close | |
close
DescriptionAdditional response data returned by RetailDecisions
|
|||
fraudCode | string | no | read close |
close
DescriptionResult of the fraud service.
Provides additional information about the fraud result
|
|||
fraudNeural | string | no | read close |
close
DescriptionReturns the raw score of the neural
|
|||
fraudRCF | string | no | read close |
close
DescriptionResult of the fraud service
Represent sets of fraud rules returned during the evaluation of the transaction
|
|||
initialSchemeTransactionId | string | no | read close |
close
DescriptionThe unique scheme transactionId of the initial transaction that was performed with SCA.
Should be stored by the merchant to allow it to be submitted in future transactions. |
|||
networkTokenUsed | boolean | no | read close |
close
DescriptionIndicates if a network token was used during the payment.
|
|||
paymentProductId | integer | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
schemeTransactionId | string | no | read close |
close
DescriptionThe unique scheme transactionId of this transaction.
Should be stored by the merchant to allow it to be submitted in future transactions. Use this value in case the initialSchemeTransactionId property is empty. |
|||
object | no | read close | |
acsTransactionId | string | no | read close |
close
DescriptionIdentifier of the authenticated transaction at the ACS/Issuer
|
|||
appliedExemption | string | no | read close |
close
DescriptionExemption code from Carte Bancaire (130) (unknown possible values so far -free format)
|
|||
object | no | read close | |
close
DescriptionThe amount for which this transaction has been authenticated.
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
cavv | string | no | read close |
close
DescriptionCAVV or AVV result indicating authentication validation value
|
|||
directoryServerTransactionId | string | no | read close |
close
DescriptionThe 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
|
|||
eci | string | no | read close |
close
DescriptionIndicates Authentication validation results returned after AuthenticationValidation
|
|||
object | no | read close | |
exemptionRaised | string | no | read close |
close
DescriptionType of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
|
|||
exemptionRejectionReason | string | no | read close |
close
DescriptionThe request exemption could not be granted. The reason why is returned in this property.
|
|||
exemptionRequest | string | no | read close |
close
DescriptionType of strong customer authentication (SCA) exemption requested by you for this transaction.
|
|||
schemeRiskScore | integer | no | read close |
close
DescriptionGlobal score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
|
|||
object | no | read close | |
sdkTransactionId | string | no | read close |
close
DescriptionUniversally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
|
|||
object | no | read close | |
close
DescriptionObject containing data regarding the 3-D Secure authentication
|
|||
acsTransactionId | string (36) | no | read close |
close
DescriptionThe ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
|
|||
method | string | no | read close |
close
DescriptionMethod of authentication used for this transaction.
Possible values:
|
|||
utcTimestamp | string (12) | no | read close |
close
DescriptionTimestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
|
|||
threeDSecureVersion | string | no | read close |
close
DescriptionThe 3-D Secure version used for the authentication.
This property is used in the communication with the acquirer |
|||
threeDServerTransactionId | string | no | read close |
close
DescriptionThe 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
|
|||
xid | string | no | read close |
close
DescriptionTransaction ID for the Authentication
|
|||
token | string | no | read close |
close
DescriptionIf a token was used for or created during the payment, then the ID of that token.
|
|||
object | one of the group | read close | |
close
DescriptionObject containing the cash payment method details
|
|||
object | no | read close | |
close
DescriptionObject containing the results of the fraud screening
|
|||
fraudServiceResult | string | no | read close |
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
object | no | read close | |
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
deviceCategory | string | no | read close |
close
DescriptionThe type of device used by the customer. Example values:
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
riskScore | string | no | read close |
close
DescriptionThe score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
|
|||
trueIpAddressCountry | string | no | read close |
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
object | no | read close | |
close
DescriptionThis object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
|
|||
clauseName | string | no | read close |
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
deviceCountryCode | string | no | read close |
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
policyApplied | string | no | read close |
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
userDeviceType | string | no | read close |
close
DescriptionThe type of device used by the customer.
|
|||
paymentProductId | integer | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
object | one of the group | read close | |
close
DescriptionObject containing the non SEPA direct debit payment method details
|
|||
object | no | read close | |
close
DescriptionObject containing the results of the fraud screening
|
|||
fraudServiceResult | string | no | read close |
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
object | no | read close | |
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
deviceCategory | string | no | read close |
close
DescriptionThe type of device used by the customer. Example values:
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
riskScore | string | no | read close |
close
DescriptionThe score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
|
|||
trueIpAddressCountry | string | no | read close |
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
object | no | read close | |
close
DescriptionThis object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
|
|||
clauseName | string | no | read close |
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
deviceCountryCode | string | no | read close |
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
policyApplied | string | no | read close |
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
userDeviceType | string | no | read close |
close
DescriptionThe type of device used by the customer.
|
|||
paymentProductId | integer | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
object | one of the group | read close | |
close
DescriptionObject containing the e-invoice payment method details
|
|||
object | no | read close | |
close
DescriptionObject containing the results of the fraud screening
|
|||
fraudServiceResult | string | no | read close |
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
object | no | read close | |
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
deviceCategory | string | no | read close |
close
DescriptionThe type of device used by the customer. Example values:
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
riskScore | string | no | read close |
close
DescriptionThe score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
|
|||
trueIpAddressCountry | string | no | read close |
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
object | no | read close | |
close
DescriptionThis object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
|
|||
clauseName | string | no | read close |
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
deviceCountryCode | string | no | read close |
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
policyApplied | string | no | read close |
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
userDeviceType | string | no | read close |
close
DescriptionThe type of device used by the customer.
|
|||
object | yes | read close | |
close
DescriptionAfterPay Installments (payment product 9000) specific details
|
|||
installmentId | string | yes | read close |
close
DescriptionThe ID of the installment plan used for the payment.
|
|||
paymentProductId | integer | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
object | one of the group | read close | |
close
DescriptionObject containing the invoice payment method details
|
|||
object | no | read close | |
close
DescriptionObject containing the results of the fraud screening
|
|||
fraudServiceResult | string | no | read close |
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
object | no | read close | |
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
deviceCategory | string | no | read close |
close
DescriptionThe type of device used by the customer. Example values:
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
riskScore | string | no | read close |
close
DescriptionThe score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
|
|||
trueIpAddressCountry | string | no | read close |
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
object | no | read close | |
close
DescriptionThis object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
|
|||
clauseName | string | no | read close |
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
deviceCountryCode | string | no | read close |
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
policyApplied | string | no | read close |
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
userDeviceType | string | no | read close |
close
DescriptionThe type of device used by the customer.
|
|||
paymentProductId | integer | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
object | one of the group | read close | |
close
DescriptionObject containing the mobile payment method details
|
|||
authorisationCode | string | no | read close |
close
DescriptionCard Authorization code as returned by the acquirer
|
|||
object | no | read close | |
close
DescriptionFraud results contained in the CardFraudResults object
|
|||
avsResult | string | no | read close |
close
DescriptionResult of the Address Verification Service checks. Possible values are:
|
|||
cvvResult | string | no | read close |
close
DescriptionResult of the Card Verification Value checks. Possible values are:
|
|||
fraudServiceResult | string | no | read close |
close
DescriptionResulting advice of the fraud prevention checks. Possible values are:
|
|||
object | no | read close | |
close
DescriptionResults of Fraugster fraud prevention check. Fraugster collects transaction data points such as name, email address, billing, etc. to analyze whether or not the transaction is fraudulent.
|
|||
fraudInvestigationPoints | string | no | read close |
close
DescriptionResult of the Fraugster check
Contains the investigation points used during the evaluation
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Fraugster check
Contains the overall Fraud score which is an integer between 0 and 99
|
|||
object | no | read close | |
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
deviceCategory | string | no | read close |
close
DescriptionThe type of device used by the customer. Example values:
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
riskScore | string | no | read close |
close
DescriptionThe score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
|
|||
trueIpAddressCountry | string | no | read close |
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
object | no | read close | |
close
DescriptionThis object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
|
|||
clauseName | string | no | read close |
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
deviceCountryCode | string | no | read close |
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
policyApplied | string | no | read close |
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
userDeviceType | string | no | read close |
close
DescriptionThe type of device used by the customer.
|
|||
object | no | read close | |
close
DescriptionAdditional response data returned by RetailDecisions
|
|||
fraudCode | string | no | read close |
close
DescriptionResult of the fraud service.
Provides additional information about the fraud result
|
|||
fraudNeural | string | no | read close |
close
DescriptionReturns the raw score of the neural
|
|||
fraudRCF | string | no | read close |
close
DescriptionResult of the fraud service
Represent sets of fraud rules returned during the evaluation of the transaction
|
|||
network | string | no | read close |
close
DescriptionThe network that was used for the refund
|
|||
object | no | read close | |
dpan | string (19) | yes | read close |
close
DescriptionThe obfuscated DPAN. Only the last four digits are visible.
|
|||
expiryDate | string (4) | yes | read close |
close
DescriptionExpiry date of the tokenized card
Format: MMYY |
|||
paymentProductId | integer | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
object | no | read close | |
acsTransactionId | string | no | read close |
close
DescriptionIdentifier of the authenticated transaction at the ACS/Issuer
|
|||
appliedExemption | string | no | read close |
close
DescriptionExemption code from Carte Bancaire (130) (unknown possible values so far -free format)
|
|||
object | no | read close | |
close
DescriptionThe amount for which this transaction has been authenticated.
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
cavv | string | no | read close |
close
DescriptionCAVV or AVV result indicating authentication validation value
|
|||
directoryServerTransactionId | string | no | read close |
close
DescriptionThe 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
|
|||
eci | string | no | read close |
close
DescriptionIndicates Authentication validation results returned after AuthenticationValidation
|
|||
object | no | read close | |
exemptionRaised | string | no | read close |
close
DescriptionType of strong customer authentication (SCA) exemption that was raised towards the acquirer for this transaction.
|
|||
exemptionRejectionReason | string | no | read close |
close
DescriptionThe request exemption could not be granted. The reason why is returned in this property.
|
|||
exemptionRequest | string | no | read close |
close
DescriptionType of strong customer authentication (SCA) exemption requested by you for this transaction.
|
|||
schemeRiskScore | integer | no | read close |
close
DescriptionGlobal score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99
|
|||
object | no | read close | |
sdkTransactionId | string | no | read close |
close
DescriptionUniversally unique transaction identifier assigned by the 3-D Secure SDK to identify this transaction.
|
|||
object | no | read close | |
close
DescriptionObject containing data regarding the 3-D Secure authentication
|
|||
acsTransactionId | string (36) | no | read close |
close
DescriptionThe ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
|
|||
method | string | no | read close |
close
DescriptionMethod of authentication used for this transaction.
Possible values:
|
|||
utcTimestamp | string (12) | no | read close |
close
DescriptionTimestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
|
|||
threeDSecureVersion | string | no | read close |
close
DescriptionThe 3-D Secure version used for the authentication.
This property is used in the communication with the acquirer |
|||
threeDServerTransactionId | string | no | read close |
close
DescriptionThe 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
|
|||
xid | string | no | read close |
close
DescriptionTransaction ID for the Authentication
|
|||
object | one of the group | read close | |
close
DescriptionObject containing the redirect payment product details
|
|||
object | no | read close | |
close
DescriptionObject that holds the Basic Bank Account Number (BBAN) data
|
|||
accountHolderName | string (30) | depends | read close |
close
DescriptionName of the account holder
|
|||
accountNumber | string | depends | read close |
close
DescriptionBank account number
|
|||
bankCode | string | depends | read close |
close
DescriptionBank code
|
|||
bankName | string (40) | no | read close |
close
DescriptionName of the bank
|
|||
branchCode | string | no | read close |
close
DescriptionBranch code
|
|||
checkDigit | string | no | read close |
close
DescriptionBank check digit
|
|||
countryCode | string (2) | no | read close |
close
DescriptionISO 3166-1 alpha-2 country code of the country where the bank account is held
For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
|
|||
object | no | read close | |
close
DescriptionObject containing account holder name and IBAN information
|
|||
accountHolderName | string (30) | depends | read close |
close
DescriptionName in which the account is held.
|
|||
iban | string (50) | depends | read close |
close
DescriptionThe IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
|
|||
bic | string | no | read close |
close
DescriptionThe BIC is the Business Identifier Code, also known as SWIFT or Bank Identifier code. It is a code with an internationally agreed format to Identify a specific bank or even branch. The BIC contains 8 or 11 positions: the first 4 contain the bank code, followed by the country code and location code.
|
|||
object | no | read close | |
close
DescriptionObject containing the results of the fraud screening
|
|||
fraudServiceResult | string | no | read close |
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
object | no | read close | |
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
deviceCategory | string | no | read close |
close
DescriptionThe type of device used by the customer. Example values:
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
riskScore | string | no | read close |
close
DescriptionThe score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
|
|||
trueIpAddressCountry | string | no | read close |
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
object | no | read close | |
close
DescriptionThis object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
|
|||
clauseName | string | no | read close |
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
deviceCountryCode | string | no | read close |
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
policyApplied | string | no | read close |
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
userDeviceType | string | no | read close |
close
DescriptionThe type of device used by the customer.
|
|||
object | no | read close | |
close
DescriptionPostFinance Card (payment product 3201) specific details
|
|||
object | no | read close | |
cardNumber | string (19) | no | read close |
close
DescriptionThe complete credit/debit card number
|
|||
cardholderName | string | no | read close |
close
DescriptionThe card holder's name on the card.
|
|||
expiryDate | string (4) | no | read close |
close
DescriptionExpiry date of the card
Format: MMYY |
|||
object | no | read close | |
close
DescriptionTrustly (payment product 806) specific details
|
|||
object | no | read close | |
close
DescriptionObject containing the billing address details of the customer
|
|||
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes no | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
accountLastDigits | string | no | read close |
close
DescriptionThe last digits of the account number
|
|||
bankName | string | no | read close |
close
DescriptionThe name of the bank
|
|||
clearinghouse | string | no | read close |
close
DescriptionThe country of the clearing house
|
|||
personIdentificationNumber | string | no | read close |
close
DescriptionThe ID number of the account holder
|
|||
object | no | read close | |
close
DescriptionSofort (payment product 836) specific details
|
|||
securityIndicator | string | no | read close |
close
DescriptionIndicates if SofortBank could estabilish if the transaction could successfully be processed.
|
|||
object | no | read close | |
close
DescriptionPayPal (payment product 840) specific details
|
|||
object | no | read close | |
close
DescriptionObject containing the billing address details of the customer
|
|||
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes no | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
close
DescriptionObject containing the details of the PayPal account
|
|||
accountId | string | no | read close |
close
DescriptionUsername with which the PayPal account holder has registered at PayPal
|
|||
billingAgreementId | string | no | read close |
close
DescriptionIdentification of the PayPal recurring billing agreement
|
|||
companyName | string | no | read close |
close
DescriptionName of the company in case the PayPal account is owned by a business
|
|||
contactPhone | string | no | read close |
close
DescriptionThe phone number of the PayPal account holder
|
|||
countryCode | string | no | read close |
close
DescriptionCountry where the PayPal account is located
|
|||
customerAccountStatus | string | no | read close |
close
DescriptionStatus of the PayPal account.
Possible values are:
|
|||
customerAddressStatus | string | no | read close |
close
DescriptionStatus of the customer's shipping address as registered by PayPal
Possible values are:
|
|||
firstName | string | no | read close |
close
DescriptionFirst name of the PayPal account holder
|
|||
payerId | string | no | read close |
close
DescriptionThe unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
|
|||
surname | string | no | read close |
close
DescriptionSurname of the PayPal account holder
|
|||
object | no | read close | |
close
DescriptionObject containing the address details of the customer
|
|||
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes no | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
close
DescriptionProtection Eligibility data of the PayPal customer
|
|||
eligibility | string | no | read close |
close
DescriptionPossible values:
|
|||
type | string | no | read close |
close
DescriptionPossible values:
|
|||
paymentProductId | integer | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
token | string | no | read close |
close
DescriptionID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
|
|||
object | one of the group | read close | |
close
DescriptionObject containing the SEPA direct debit details
|
|||
object | no | read close | |
close
DescriptionObject containing the results of the fraud screening
|
|||
fraudServiceResult | string | no | read close |
close
DescriptionResults from the fraud prevention check. Possible values are:
|
|||
object | no | read close | |
close
DescriptionObject containing device fingerprinting details from InAuth
|
|||
deviceCategory | string | no | read close |
close
DescriptionThe type of device used by the customer. Example values:
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
riskScore | string | no | read close |
close
DescriptionThe score calculated on the basis of Anomalies, Velocity, Location, Integrity, List-Based, and Device Reputation. Range of the score is between 0 and 100. A lower value is better.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by inAuth. This might be different from the IP address that you are seeing on your side due to the proxy piercing technology deployed by inAuth.
|
|||
trueIpAddressCountry | string | no | read close |
close
DescriptionThe country of the customer based on the location of the True IP Address determined by inAuth.
|
|||
object | no | read close | |
close
DescriptionThis object contains the results of Microsoft Fraud Protection risk assessment. Microsoft collects transaction data points and uses Adaptive AI that continuously learns to protect you against payment fraud, and the device fingerprinting details from the Microsoft Device Fingerprinting service.
|
|||
clauseName | string | no | read close |
close
DescriptionName of the clause within the applied policy that was triggered during the evaluation of this transaction.
|
|||
deviceCountryCode | string | no | read close |
close
DescriptionThe country of the customer determined by Microsoft Device Fingerprinting.
|
|||
deviceId | string | no | read close |
close
DescriptionThis is the device fingerprint value. Based on the amount of data that the device fingerprint collector script was able to collect, this will be a proxy ID for the device used by the customer.
|
|||
fraudScore | integer | no | read close |
close
DescriptionResult of the Microsoft Fraud Protection check. This contains the normalized fraud score from a scale of 0 to 100. A higher score indicates an increased risk of fraud.
|
|||
policyApplied | string | no | read close |
close
DescriptionName of the policy that was applied on during the evaluation of this transaction.
|
|||
trueIpAddress | string | no | read close |
close
DescriptionThe true IP address as determined by Microsoft Device Fingerprinting.
|
|||
userDeviceType | string | no | read close |
close
DescriptionThe type of device used by the customer.
|
|||
object | yes | read close | |
close
DescriptionOutput that is SEPA Direct Debit specific (i.e. the used mandate)
|
|||
mandateReference | string | no | read close |
close
DescriptionUnique reference to a Mandate
|
|||
paymentProductId | integer | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
token | string | no | read close |
close
DescriptionID of the token. This property is populated for the GlobalCollect payment platform when the payment was done with a token or when the payment was tokenized.
|
|||
paymentMethod | string | no | read close |
close
DescriptionPayment method identifier used by the our payment engine with the following possible values:
|
|||
object | no | read close | |
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
merchantOrderId | integer | no | read close |
close
DescriptionYour order ID for this transaction that is also returned in our report files
|
|||
merchantReference | string | no | read close |
close
DescriptionYour unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
|
|||
paymentReference | string | no | read close |
close
DescriptionPayment Reference generated by WebCollect
|
|||
providerId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
providerMerchantId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
providerReference | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
referenceOrigPayment | string | no | read close |
close
DescriptionWhen you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
|
|||
reversalReason | string | no | read close |
close
DescriptionThe reason description given for the reversedAmount property.
|
|||
id | string | no | read close |
close
DescriptionOur unique capture transaction identifier.
|
|||
status | enum | no | read close |
close
DescriptionCurrent high-level status of the captures in a human-readable form. Possible values are :
Please see Statuses for a full overview of possible values. |
|||
object | no | read close | |
close
DescriptionThis 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.
|
|||
isRetriable | boolean | no | read close |
close
DescriptionFlag indicating whether a rejected payment may be retried by the merchant without incurring a fee
|
|||
array of object | no | read close | |
close
DescriptionThis is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
|
|||
object | no | read close | |
key | string | no | read close |
close
DescriptionName of the key or property
|
|||
value | string | no | read close |
close
DescriptionValue of the key or property
|
|||
statusCode | integer | no | read close |
close
DescriptionNumeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
|
Response example
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 } }