Ecom Payments
A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.
63bbc548-d2de-4546-b106-880a5018461cEcommerce Payment Result
The ID of the transaction.
76944d4b-89e6-48d2-ac04-675383c3eedfThe identifier of payment provider contract you want to process the transaction request with.
30b8bec8-5042-4e67-939c-5453fbe41711Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
0True if the transaction has been blocked by a ruleset, false otherwise
The time at which the transaction was created.
The ID of a customer
A reference specified by the merchant to identify the transaction
The payment product corresponding to this transaction
The name of the processor used for this transaction
Reference identifying the transaction, as provided by the processor.
Stores all details specific for the processor of the transaction.
The outcome of the payment request.
AUTHORIZEDPossible values: Message provided by the 3rd party service as additional information, when the transaction does not succeed.
Acquirer reference number. Generated by the Acquirer at the time of clearing for card transactions.
-
When the payment is authorized successfully, this field holds the authorization code for the payment.
-
When the payment is not authorized, this field is not returned.
5B1D4CAddress verification services result, which provides information about the outcome of the AVS check. The full list of codes and descriptions can be found here
APossible values: The token representing the payment card
The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order
True if the card was used with a cvv
The CVC verification result, which provides information about the outcome of the CVC check.
CVC-CVV result codes:
0Unknown1Matches.2Doesn't match.3Not checked.4No CVC/CVV provided, but was required.5Issuer not certified for CVC/CVV.6No CVC/CVV provided.
The following are included only for backwards compatibility. They are deprecated and will be removed in the next major release. The client must take action now to ensure ongoing support.
MMatchYMatchNNo MatchPNot ProcessedSCVV Should be present, but Merchant indicates not present.UIssuer not certified or registered to process card verification.
1Possible values: This field will be populated for any Verified by Visa transaction and AVV Authorisation message sent by MasterCard SecureCode: This includes CAVV and AEVV from American Express SafeKey.
CAVV Transaction Response Code Values:
-
0CAVV or AEVV Not Validated due to erroneous data submitted. -
1CAVV or AEVV Failed Validation - Authentication Transaction. This is an indication of potential bad or fraudulent data submitted. -
2CAVV or AEVV Passed Validation – Authentication Transaction. -
3CAVV or AEVV Passed Validation – Attempted Authentication Transaction. (Determined that the Issuer ACS generated this value from the use of the Issuer’s CAVV/AEVV key[s]). -
4CAVV or AEVV Failed Validation – Attempted Authentication Transaction. Attempted Authentication Transaction. This is an indication of potential bad or fraudulent data submitted as the CAVV/AEVV. (Determined that Visa generated this value from the use of CAVV/AEVV key[s]). -
5Reserved. -
6CAVV or AEVV Not Validated – Issuer not participated. This value is generated when an Issuer requests thedo not verifyflag to be established for its BINs. This parameter enables an Issuer to temporarily stop CAVV/AEVV verification while resolving CAVV/AEVV key issues. VisaNet processes this value as a valid CAVV/AEVV. -
7CAVV or AEVV Failed Validation – Attempted Authentication Transaction. This is an indication of potential bad or fraudulent data submitted as the CAVV/AEVV. (CAVV/AEVV generated with Visa Key). -
8CAVV or AEVV Passed Validation – Attempted Authentication Transaction. (CAVV/AEVV generated with Visa Key). -
9CAVV or AEVV Failed Validation – Attempted Authentication Transaction. This is an indication of potential bad or fraudulent data submitted as the CAVV/AEVV (CAVV/AEVV generated with Visa Key – Issuer ACS unavailable). -
99An unknown value was returned from the processor. -
ACAVV or AEVV Passed Validation – Attempted Authentication Transaction. (CAVV/AEVV generated with Visa Key – Issuer ACS unavailable). -
BCAVV or AEVV Failed Validation – Attempted Authentication Transaction. This is an indication of potential bad or fraudulent data submitted as the CAVV/AEVV. (CAVV/AEVV generated with Visa Key). -
CCAVV or AEVV Not Validated – Attempted Authentication Transaction. Issuer did not return a CAVV/AEVV results code in the authorisation response. VisaNet will treat this as valid CAVV/AEVV if the Issuer approves the authorisation. -
DCAVV or AEVV Not Validated – Authentication. Issuer did not return a CAVV/AEVV results code in the authorisation response. VisaNet will treat this as valid CAVV/AEVV if the Issuer approves the authorisation. -
IInvalid Security Data. -
UIssuer does not participate or 3-D Secure data not utilised. -
NABlank CAVV or AEVV Not Present.
99Possible values: Optional. The invoice number to track this payment.
A reason code assigned by the acquiring platform; '0000' in case of success
A client (user friendly) identifier for the transaction generated at the outset of a business event. The format will be dependent on the calling system.
A reference supplied by the system retaining the original source information and used to assist in locating that transaction or a copy of the transaction. This value is critical in matching values that are sent to other Payment processors or Acquirers. This value would correspond to the ISO8583 specification as RRN in attribute DE 37, which limits the value to being an alphanumeric value 12 characters.
For the GSC client android application the format will correspond to YYMMdd<stan 6 digits>.
200211654321Determines the point of sale of a customer. Possible values: pos, moto, mail_order, telephone_order, ecommerce and cont_auth
System Trace Audit Number.
Indicates to the API client if a technical reversal has been completed by Verifone.
NONEPossible values: The latitude / longitude resolved from the customer's ip address.
["52.370216","4.895168"]The city resolved from the customer's ip address.
West RoxburyThe country code resolved from the customer's ip address.
USA code defined by the merchant that affects the calculation of the total amount.
The purchase order number. It can be provided in transactions with purchase or procurement cards for the cardholder to get better interchange rates (note that this functionality needs alignment with the acquirer and the scheme). This field is part of so-called Level 2 data.
Balance amount is the amount remaining on a card or account of cardholder without a decimal place e.g. $1.5 = 150.
The required number of decimal places for a currency code is according to ISO 4217. However the following table takes precedence over ISO 4217:
Bad Request
Unauthorised
Forbidden
Not Found
Internal Server Error
A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.
63bbc548-d2de-4546-b106-880a5018461cThe identifier of payment provider contract you want to process the transaction request with.
30b8bec8-5042-4e67-939c-5453fbe41711Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
0Flags a payment request for either pre-authorization or final authorization.
-
PRE_AUTHis used when the authorized amount is unknown and can be adjusted later. -
FINAL_AUTHis used when a final authorized amount is known and the transaction will definitely be captured in whole.
FINAL_AUTHPossible values: Whether auto-capture or not. Setting the value to 'false' will only authorize the transaction.
trueExample: falseThe ID of a customer.
0a57b387-2ba7-4f65-be2f-e176bb49d2ceThe IP Address of the customer where the transaction was initiated.
127.0.0.1A short descriptor to be shown on bank statement of the customer. Please refer to the integration guide for the format requirements.
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140Defines the type of receipt to be generated
Determines the sales channel the shopper gives their card details through:
-
ECOMMERCEOnline transactions where the cardholder is present. -
MAILorder transactions where the shopper is in contact with the merchant via email. -
TELEPHONEorder transactions where the shopper is in contact with the merchant via telephone.
ECOMMERCEExample: ECOMMERCEPossible values: The full user agent string of the device the customer used to submit the transaction.
A reference used by the merchant to typically capture a description of the service provided. It could then be used by the merchant to help locate transactions. One could envision a situation where a merchant is trying to locate a transaction/ receipt but in speaking with the customer, the only (or at least a predominant) detail is what service was rendered
Use this field to request your transaction to be exempted from the application of the Strong Customer Authentication (SCA). Be advised that the use of this field may result to your liability in case of fraudulent transaction.
Possible Values:
1 - Low value payment
2 - Acquirer Transaction Risk Analysis
3 - Trusted beneficiary exemption
4 - Secure Corporate Payment (SCP) exemption
5 - Merchant Initiated Transaction
6 - SCA Delegation
Three-letter ISO 4217 alphabetical currency code. e.g. USD.
Values correspond to ISO 4217.
Represents a Card type or brand. It should correspond to a consistent name, the list of standard names is as follows:
| Value | Description |
|---|---|
| AMEX | American Express |
| CB | Carte Bancaires |
| DINERS | Diners Club International |
| DISCOVER | Diners Club Discover |
| JCB | Japan Credit Bureau |
| MAESTRO | Multi-national Debit (MasterCard) |
| MASTERCARD | MasterCard |
| VISA | Visa |
| UPI | Union Pay International |
| GIFT_CARD | Gift Card (Generic) |
| PLCC | Private Label Credit Card |
| Other local schemes as applicable. Enter a pre-defined name to represent the scheme or type. | |
| Note: 1. For gift cards, card brand is mandatory and the value should be GIFT_CARD. |
- This parameter is mandatory for dual branded cards.
This is an optional field that is only supported with reuse_token or stored_credentials.reference.
For dual-branded cards identifies whether selection is made by a cardholder or merchant.
MERCHANTPossible values: The reason a transaction has been refused within the payment ecosystem by the client/Verifone/acquirer. This needs to be set by the component that is refusing this transaction request.
The encrypted payload object provided by the Wallet on the frontend
Determines if 3ds is needed:
| sca_compliance_level | WalletPayload authMethod | Additional 3ds |
|---|---|---|
| NONE | N/A | NO |
| WALLET | PAN_ONLY | YES |
| WALLET | 3DS_CRYPTOGRAM | NO |
| FORCE_3DS | N/A | YES |
WALLETPossible values: A code defined by the merchant that affects the calculation of the total amount.
The purchase order number. It can be provided in transactions with purchase or procurement cards for the cardholder to get better interchange rates (note that this functionality needs alignment with the acquirer and the scheme). This field is part of so-called Level 2 data.
This field indicates the taxable status of the transaction (if any of the purchased items are taxable). This field is part of so-called Level 2 data. If the value TAX_PROVIDED is sent, tax_amount should also be provided
TAX_NOT_PROVIDEDPossible values: Wallet Result
Bad Request
Unauthorised
Forbidden
Not Found
Internal Server Error
The URL pointing to the Apple Pay validation location.
Note: Use the URL below according to your Verifone environment:
The domain from which the payment request will be initiated.
The identifier of payment provider contract you want to process the transaction request with.
30b8bec8-5042-4e67-939c-5453fbe41711The Apple Pay Validation Response.
object (Apple Pay opaque session object)
Bad Request
Unauthorised
Forbidden
Not Found
Internal Server Error
A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.
63bbc548-d2de-4546-b106-880a5018461cThe identifier of payment provider contract you want to process the transaction request with.
30b8bec8-5042-4e67-939c-5453fbe41711The Phone Number registered with Vipps Mobile APP.
+31-6-11223344Checkout Redirect URL which will be used by Vipps on Payment Completion.
Flag to identify the transaction originated from APP or Browser.
falseExample: falseAmount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150Flags a payment request for either pre-authorization or final authorization.
PRE_AUTHis used when the authorized amount is unknown and can be adjusted later.FINAL_AUTHis used when a final authorized amount is known and the transaction will definitely be captured in whole.
FINAL_AUTHPossible values: Whether auto-capture or not. Setting the value to 'false' will only authorize the transaction.
trueExample: falseThe ID of a customer.
0a57b387-2ba7-4f65-be2f-e176bb49d2ceThe IP Address of the customer where the transaction was initiated.
127.0.0.1A short descriptor to be shown on bank statement of the customer. Please refer to the integration guide for the format requirements.
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The full user agent string of the device the customer used to submit the transaction.
A reference used by the merchant to typically capture a description of the service provided. It could then be used by the merchant to help locate transactions. One could envision a situation where a merchant is trying to locate a transaction/ receipt but in speaking with the customer, the only (or at least a predominant) detail is what service was rendered
Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to ISO 4217.
Please note that Klarna only supports Norwegian krone (NOK).
NONE: No SCA required.WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.
WALLETPossible values: Use this field to request your transaction to be exempted from the application of the Strong Customer Authentication (SCA). Be advised that the use of this field may result to your liability in case of fraudulent transaction. Possible Values: 1 - Low value payment 2 - Acquirer Transaction Risk Analysis 3 - Trusted beneficiary exemption 4 - Secure Corporate Payment (SCP) exemption 5 - Merchant Initiated Transaction 6 - SCA Delegation.
NOTE: This only applies when sca_compliance_level = NONE
The Vipps Payment Initiation Response.
The ID of the transaction.
76944d4b-89e6-48d2-ac04-675383c3eedfVipps Host Redirection URL.
Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150True if the transaction has been blocked by a ruleset, false otherwise
The time at which the transaction was created.
The ID of a customer
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The name of the processor used for this transaction
NETSThe payment product corresponding to this transaction
CARDThe payment product type corresponding to this transaction. Fees applied to the transaction, is based on the payment product
UnknownPossible values: The outcome of the payment request.
AUTHORIZEDPossible values: Message provided by the 3rd party service as additional information, when the transaction does not succeed.
The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order
Determines the sales channel the shopper gives their card details through:
-
ECOMMERCEOnline transactions where the cardholder is present. -
MAILorder transactions where the shopper is in contact with the merchant via email. -
TELEPHONEorder transactions where the shopper is in contact with the merchant via telephone.
ECOMMERCEExample: ECOMMERCEPossible values: The latitude / longitude resolved from the customer's ip address.
[52.370216,4.895168]The city resolved from the customer's ip address.
West RoxburyThe ISO 3166-1 alpha-2 country code.
Note: The country code for Great Britain is.GBand notUKas is used in that country's top-level domain names.
AUBad Request
Unauthorised Request
Forbidden Request
Not Found Request
Internal Error
A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.
63bbc548-d2de-4546-b106-880a5018461cThe identifier of payment provider contract you want to process the transaction request with.
30b8bec8-5042-4e67-939c-5453fbe41711Checkout Redirect URL which will be used by MobilePay on Payment Completion.
Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
0Flags a payment request for either pre-authorization or final authorization.
PRE_AUTHis used when the authorized amount is unknown and can be adjusted later.FINAL_AUTHis used when a final authorized amount is known and the transaction will definitely be captured in whole.
FINAL_AUTHPossible values: Whether auto-capture or not. Setting the value to 'false' will only authorize the transaction.
trueExample: falseThe ID of a customer.
0a57b387-2ba7-4f65-be2f-e176bb49d2ceThe IP Address of the customer where the transaction was initiated.
127.0.0.1A short descriptor to be shown on bank statement of the customer. Please refer to the integration guide for the format requirements.
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The full user agent string of the device the customer used to submit the transaction.
A reference used by the merchant to typically capture a description of the service provided. It could then be used by the merchant to help locate transactions. One could envision a situation where a merchant is trying to locate a transaction/ receipt but in speaking with the customer, the only (or at least a predominant) detail is what service was rendered
Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to ISO 4217.
Please note that Klarna only supports EURO (EUR) and Danish krone (DKK).
NONE: No SCA required.WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.
WALLETPossible values: Use this field to request your transaction to be exempted from the application of the Strong Customer Authentication (SCA). Be advised that the use of this field may result to your liability in case of fraudulent transaction. Possible Values: 1 - Low value payment 2 - Acquirer Transaction Risk Analysis 3 - Trusted beneficiary exemption 4 - Secure Corporate Payment (SCP) exemption 5 - Merchant Initiated Transaction 6 - SCA Delegation.
NOTE: This only applies when sca_compliance_level = NONE
The MobilePay Payment Initiation Response.
The ID of the transaction.
76944d4b-89e6-48d2-ac04-675383c3eedfMobilePay Host Redirection URL.
Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150True if the transaction has been blocked by a ruleset, false otherwise
The time at which the transaction was created.
The ID of a customer
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The name of the processor used for this transaction
NETSThe payment product corresponding to this transaction
CARDThe payment product type corresponding to this transaction. Fees applied to the transaction, is based on the payment product
UnknownPossible values: The outcome of the payment request.
AUTHORIZEDPossible values: Message provided by the 3rd party service as additional information, when the transaction does not succeed.
The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order
Determines the sales channel the shopper gives their card details through:
-
ECOMMERCEOnline transactions where the cardholder is present. -
MAILorder transactions where the shopper is in contact with the merchant via email. -
TELEPHONEorder transactions where the shopper is in contact with the merchant via telephone.
ECOMMERCEExample: ECOMMERCEPossible values: The latitude / longitude resolved from the customer's ip address.
[52.370216,4.895168]The city resolved from the customer's ip address.
West RoxburyThe ISO 3166-1 alpha-2 country code.
Note: The country code for Great Britain is.GBand notUKas is used in that country's top-level domain names.
AUBad Request
Unauthorised Request
Forbidden Request
Not Found Request
Internal Error
A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.
63bbc548-d2de-4546-b106-880a5018461cThe identifier of merchant entity you want to process the transaction request with. Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
30b8bec8-5042-4e67-939c-5453fbe41711Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150Tax Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details.
Checkout Redirect URL which will be used by Klarna on Payment Completion.
Whether auto-capture or not. Setting the value to 'false' will only authorize the transaction.
trueExample: falseThe ID of a customer.
0a57b387-2ba7-4f65-be2f-e176bb49d2ceThe IP Address of the customer where the transaction was initiated.
127.0.0.1A short descriptor to be shown on bank statement of the customer. Please refer to the integration guide for the format requirements.
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The full user agent string of the device the customer used to submit the transaction.
A reference used by the merchant to typically capture a description of the service provided. It could then be used by the merchant to help locate transactions. One could envision a situation where a merchant is trying to locate a transaction/ receipt but in speaking with the customer, the only (or at least a predominant) detail is what service was rendered
Three-letter ISO 4217 alphabetical currency code. e.g. EUR. Values correspond to ISO 4217.
Please note that Klarna only supports EURO (EUR), Norwegian krone (NOK) , Swedish krona (SEK) and Danish krone (DKK).
Klarna Initiate Payment Result.
The ID of the transaction.
76944d4b-89e6-48d2-ac04-675383c3eedfIn-store reference for the transaction
Client token returned by klarna host to initialize the payment process
Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150True if the transaction has been blocked by a ruleset, false otherwise
The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order
The time at which the transaction was created.
The ID of a customer
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The name of the processor used for this transaction
KLARNAThe payment product corresponding to this transaction
KLARNAThe payment product type corresponding to this transaction. Fees applied to the transaction, is based on the payment product
UnknownPossible values: The outcome of the payment request.
AUTHORIZEDPossible values: Message provided by the 3rd party service as additional information, when the transaction does not succeed.
Determines the sales channel the shopper gives their card details through:
-
ECOMMERCEOnline transactions where the cardholder is present. -
MAILorder transactions where the shopper is in contact with the merchant via email. -
TELEPHONEorder transactions where the shopper is in contact with the merchant via telephone.
ECOMMERCEExample: ECOMMERCEPossible values: The latitude / longitude resolved from the customer's ip address.
[52.370216,4.895168]The city resolved from the customer's ip address.
West RoxburyThe ISO 3166-1 alpha-2 country code.
Note: The country code for Great Britain is.GBand notUKas is used in that country's top-level domain names.
AUBad Request
Unauthorised Request
Forbidden Request
Not Found Request
Internal Error
A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.
63bbc548-d2de-4546-b106-880a5018461cThe identifier of merchant entity you want to process the transaction request with. Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
30b8bec8-5042-4e67-939c-5453fbe41711The Phone Number registered with Swish Mobile APP. This field is required for ECommerce flow, not needed MCommerce flow.
+31-6-11223344Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150The ID of a customer.
0a57b387-2ba7-4f65-be2f-e176bb49d2ceThe IP Address of the customer where the transaction was initiated.
127.0.0.1A short descriptor to be shown on bank statement of the customer and also shown in the Swish application. Max 50 chars, allowed characters are the letters a-ö, A-Ö, the numbers 0-9 and the special characters :;.,?!()” and space
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The full user agent string of the device the customer used to submit the transaction.
A reference used by the merchant to typically capture a description of the service provided. It could then be used by the merchant to help locate transactions. One could envision a situation where a merchant is trying to locate a transaction/ receipt but in speaking with the customer, the only (or at least a predominant) detail is what service was rendered
Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to ISO 4217.
Please note that Swish only supports Swedish krona (SEK).
The Swish Payment Initiation Response.
The ID of the transaction.
76944d4b-89e6-48d2-ac04-675383c3eedfAmount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150True if the transaction has been blocked by a ruleset, false otherwise
The time at which the transaction was created.
The ID of a customer
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The name of the processor used for this transaction
SWISHThe payment product corresponding to this transaction
SWISHThe payment product type corresponding to this transaction. Fees applied to the transaction, is based on the payment product
UnknownPossible values: The outcome of the payment request.
AUTHORIZEDPossible values: The outcome of the payment request.
AUTHORIZEDPossible values: The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order
Determines the sales channel the shopper gives their card details through:
-
ECOMMERCEOnline transactions where the cardholder is present. -
MAILorder transactions where the shopper is in contact with the merchant via email. -
TELEPHONEorder transactions where the shopper is in contact with the merchant via telephone.
ECOMMERCEExample: ECOMMERCEPossible values: The latitude / longitude resolved from the customer's ip address.
[52.370216,4.895168]The city resolved from the customer's ip address.
West RoxburyThe ISO 3166-1 alpha-2 country code.
Note: The country code for Great Britain is.GBand notUKas is used in that country's top-level domain names.
AUReturned when creating an m-commerce payment request. The token to use when opening the Swish app. Please find more details at Swish documentation.
Bad Request
Unauthorised Request
Forbidden Request
Not Found Request
Internal Error
A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.
63bbc548-d2de-4546-b106-880a5018461cThe identifier of payment provider contract you want to process the transaction request with.
30b8bec8-5042-4e67-939c-5453fbe41711OP bank ID for the bank to be used
Bank name for the selected Bank
Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150The ID of a customer.
0a57b387-2ba7-4f65-be2f-e176bb49d2ceA short descriptor to be shown on the invoice of the customer. Please refer to the integration guide for the format requirements.
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The full user agent string of the device the customer used to submit the transaction.
Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to ISO 4217.
Deprecated: BYR (replaced by BYN), FRF (replaced by EUR), LTL (replaced by EUR), LVL (replaced by EUR), MRO (replaced by MRU), STD (replaced by STN), USS (no replacement), VEF (replaced by VES), ZMK (replaced by ZMV) and BTC (Bitcoin only supported as Crypto Amount).
The BCP-47 language tag. Composed of:
- The ISO-639 alpha-1 or ISO-639 alpha-2 language code
- (Optional) The ISO-15924 script tag
- The ISO-3166 alpha-2 country code
es-419this message will be shown on OP's payment list
redirect url for successful payments
redirect url for cancelled payments
redirect url for rejected payments
A settlement reference specified by the merchant to identify the transaction including checksum digit.
12345678912345680000Pattern: ^[0-9]{4,20}$The OP Online Payment Initiation Response.
The ID of the transaction.
76944d4b-89e6-48d2-ac04-675383c3eedfThe payment URL can be used to redirect to transfer the money.
Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150The time at which the transaction was created.
The ID of a customer
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The name of the processor used for this transaction
OP_ONLINE_PAYMENTThe payment product corresponding to this transaction
OP_ONLINE_PAYMENTThe payment product type corresponding to this transaction. Fees applied to the transaction, is based on the payment product
UnknownPossible values: The outcome of the payment request.
AUTHORIZEDPossible values: Message provided by the 3rd party service as additional information, when the transaction does not succeed.
The latitude / longitude resolved from the customer's ip address.
[52.370216,4.895168]The city resolved from the customer's ip address.
West RoxburyThe ISO 3166-1 alpha-2 country code.
Note: The country code for Great Britain is.GBand notUKas is used in that country's top-level domain names.
AUA settlement reference specified by the merchant to identify the transaction including checksum digit.
12345678912345680000Pattern: ^[0-9]{4,20}$Bad Request
Unauthorised Request
Forbidden Request
Not Found Request
Internal Error
The OP Online Payment list of Banks Response.
Bad Request
Unauthorised Request
Forbidden Request
Not Found Request
Internal Error
A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.
63bbc548-d2de-4546-b106-880a5018461cThe identifier of payment provider contract you want to process the transaction request with.
30b8bec8-5042-4e67-939c-5453fbe41711Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150Tax Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details.
Checkout Redirect URL which will be used by Affirm on Payment Completion.
Checkout Cancel URL which will be used by Affirm on Payment Completion.
Whether auto-capture or not. Setting the to 'false' will only authorize the transaction.
trueExample: falseThe ID of a customer.
0a57b387-2ba7-4f65-be2f-e176bb49d2ceThe IP Address of the customer where the transaction was initiated.
127.0.0.1A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The full user agent string of the device the customer used to submit the transaction.
Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to ISO 4217.
Deprecated: BYR (replaced by BYN), FRF (replaced by EUR), LTL (replaced by EUR), LVL (replaced by EUR), MRO (replaced by MRU), STD (replaced by STN), USS (no replacement), VEF (replaced by VES), ZMK (replaced by ZMV) and BTC (Bitcoin only supported as Crypto Amount).
Set to modal to enable the modal checkout flow (default uses redirect checkout flow). Possible values: authorization.
MODAL:Users go through the Affirm flow in a modal window while remaining on merchant site. Modal checkout with the help of affirm.js will enable client-side callbacks so that merchant can do post checkout confirmation procedures on merchant site.REDIRECT:Users are redirected to Affirm site, where they authenticate and go through the checkout flow. Once they complete checkout, they're returned to the merchant site.
REDIRECTPossible values: The Affirm Initiation Response.
The ID of the transaction.
76944d4b-89e6-48d2-ac04-675383c3eedfA unique identifier representing the Payment Host checkout ID. This value is optional and available only in MODAL mode.
HTSZAGURU7PZ8ZAGThe merchants public api key. This value is optional and available only in MODAL mode.
The payment URL can be used to redirect to transfer the money.
Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.
150The time at which the transaction was created.
The ID of a customer
A reference specified by the merchant to identify the transaction.
7a1db7a8-6f24-4bc5-a51b-cef33fc05140The name of the processor used for this transaction
AFFIRMThe payment product corresponding to this transaction
AFFIRMThe payment product type corresponding to this transaction. Fees applied to the transaction, is based on the payment product
UnknownPossible values: The outcome of the payment request.
AUTHORIZEDPossible values: Message provided by the 3rd party service as additional information, when the transaction does not succeed.
The latitude / longitude resolved from the customer's ip address.
[52.370216,4.895168]The city resolved from the customer's ip address.
West RoxburyThe ISO 3166-1 alpha-2 country code.
Note: The country code for Great Britain is.GBand notUKas is used in that country's top-level domain names.
AUBad Request
Unauthorised Request
Forbidden Request
Not Found Request
Internal Error
Last updated
Was this helpful?