eCom Payments
How It Works
Stored Credential Business Models
API Reference
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
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.
Bad Request
Unauthorised
Forbidden
Not Found
Internal Server Error
Key Response Fields
Last updated
Was this helpful?
