Verifone Ecom Payments API is one of 27 APIs that Verifone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Ecom Payments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
10 operations
across 10 paths,
and defines 65 schemas.
It is described by OpenAPI 3.2.0, at version 2.38.1.
Requests are made against 5 base URLs: https://emea.gsc.verifone.cloud/oidc, https://us.gsc.verifone.cloud/oidc, https://nz.gsc.verifone.cloud/oidc, https://cst.test-gsc.vfims.com/oidc, https://uscst-gb.gsc.vficloud.net/oidc.
The identity and technical contract details declared by the specification.
ProcessingModelDetailsDto
object
8 properties
1 required
ForbiddenV2Docs
object
5 properties
1 required
PaymentFrequency
object
2 properties
1 required
amountDecimal
number
Amount including decimal place.
BillingDto
object
8 properties
ecomPaymentResponse_issuer_instalment_result
object
Issuer-managed instalment response. May be used to inform on supported instalment options for the transaction in specific programs (e.g., Mastercard Instalment…
12 properties
affirmPaymentInitiationResponse
object
16 properties
InstalmentDto
object
3 properties
PromoFinancingResults
object
Details of the special financing offer returned from the issuer.
7 properties
issuerCountryEnum
string
The [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO3166-1alpha-3) country code. Note: The country code for Great Britain is GB and not UK as is used in…
klarnaPaymentInitiationRequest
object
15 properties
8 required
opOnlinePaymentGetBanksResponse
array
CreateWalletDto
object
32 properties
5 required
CurrencyCodeEnum
string
Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217). Deprecated: BYR (replaced by B…
CardBrand
string
Represents a Card type or brand. It should correspond to a consistent name, the list of standard names is as follows: Value | Description ------|-------------…
PromoFinancingDetails
object
Additional details of the special financing offers to customers using private label cards, typically in combination with promocode field.
3 properties
StoredCredential
object
5 properties
TimeZone
string
A time zone, following the format defined in the IANA tz database (https://www.iana.org/time-zones). Valid examples are America/NewYork and Etc/UTC. Do not use…
AdditionalDataDto
object
10 properties
vippsPaymentInitiationRequest
object
18 properties
6 required
affirmPaymentInitiationRequest
object
15 properties
5 required
acquirerResponseMessage
string
The response description generated by the acquirer corresponding to the acquirer response code.
NotFoundV2Docs
object
5 properties
1 required
TokenDetailsRequestBody
object
The details related to the token. For Third-Party Reuse tokens, these elements might be required as additional information together with the Reuse token itself…
2 properties
ShippingInformationDto
object
The address where the purchased goods should be delivered to.
9 properties
4 required
vippsPaymentInitiationResponse
object
19 properties
VerificationAdvice
object
3 properties
opOnlinePaymentInitiationResponse
object
15 properties
TokenPaymentRequest
object
35 properties
4 required
ecomPaymentResponse_details
object
2 properties
ThreedAuthentication
object
8 properties
paymentPlanOption
object
An instalment plan option available for the transaction. Instalments are managed by the issuer. To the merchant this is just another transaction.
7 properties
initiatorTraceId
string
A number assigned by a transaction initiator(originator) to assist in identifying a transaction uniquely. The trace identifier remains unchanged for all messag…
mobilePayPaymentInitiationRequest
object
16 properties
6 required
acquirerAuthorizingNetworkIdDescriptor
string
The name or descriptor that corresponds with the acquirerauthorizingnetworkid returned in the original authorization response.
swishPaymentInitiationRequest
object
11 properties
4 required
ApplePayMerchantValidationDto
object
3 properties
3 required
InternalErrorV2Docs
object
5 properties
1 required
TokenDetails
object
19 properties
BadRequestV2Docs
object
5 properties
1 required
TokenPreferenceDto
object
4 properties
1 required
UnauthorizedV2Docs
object
5 properties
1 required
PaymentProductType
string
The payment product type corresponding to this transaction. Fees applied to the transaction, is based on the payment product
ThreeDSecure
object
8 properties
affirmLineItem
object
The description of item(s) that was included in a transaction or purchase.
12 properties
8 required
CustomerDetailsDto
object
Customer information containing billing and shipping details.
10 properties
StoredCredentialDto
object
4 properties
2 required
mobilePayPaymentInitiationResponse
object
19 properties
Details
object
2 properties
AdditionalData
object
Additional payment result data, which may be required to return in a particular payment response.
7 properties
opOnlinePaymentInitiationRequest
object
16 properties
8 required
LineItem
object
The description of item(s) that was included in a transaction or purchase.
12 properties
5 required
EcomResponseCard
object
42 properties
EncryptedCardPaymentRequest
object
32 properties
5 required
settlementDate
string
This will reflect either the desired Merchant settlement date or the actual settlement date depending where the transaction request is within the payment lifec…
acquirerAuthorizingNetworkID
string
The Network ID returned in the original authorization response.
klarnaPaymentInitiationResponse
object
21 properties
Language
string
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
acquirerResponseCode
string
Acquirer response returned during the authorisation.
DetailedAmount
object
A structure that represents a breakdown all of the different amounts that may appear on a single transaction.
3 properties
Locale
object
JSON schema for locale. Based off the BCP-47 language tag, ISO-3166 alpha-2 country code, and Olsen IANA time zone ID.
3 properties
1 required
ThreedAuthenticationDto
object
14 properties
ShippingInformation
object
9 properties
4 required
swishPaymentInitiationResponse
object
19 properties
CustomerDetailsShippingInformationDto
object
The address where the purchased goods should be delivered to.
9 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Verifone publishes across the network.
