Initiate a wallet payment using Google Pay or Apple Pay

post

https://au.gsc.verifone.cloud/oidc/api/v2/transactions/wallet

Initiate a wallet payment or verification request when amount is set to 0 (zero).

Body Params

payment_provider_contract

string

required

The identifier of payment provider contract you want to process the transaction request with.

amount

integer

required

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.

auth_type

string

enum

Defaults to FINAL_AUTH

Flags a payment request for either pre-authorization or final authorization.

PRE_AUTH is used when the authorized amount is unknown and can be adjusted later.
FINAL_AUTH is used when a final authorized amount is known and the transaction will definitely be captured in whole.

Allowed:

capture_now

boolean

Defaults to true

Whether auto-capture or not. Setting the value to 'false' will only authorize the transaction.

customer

string

The ID of a customer.

customer_ip

The IP Address of the customer where the transaction was initiated.

merchant_reference

string

length ≤ 50

A reference specified by the merchant to identify the transaction.

threed_authentication

object

MPI authentication data. Please refer to the integration guide for information on its usage.

stored_credential

object

The definition of a stored credential payment.

shipping_information

object

deprecated

The address where the purchased goods should be delivered to.
Please use customer_details.shipping.

customer_details

object

Customer information containing billing and shipping details.

shopper_interaction

string

enum

Defaults to ECOMMERCE

Determines the sales channel the shopper gives their card details through:

ECOMMERCE Online transactions where the cardholder is present.
MAIL order transactions where the shopper is in contact with the merchant via email.
TELEPHONE order transactions where the shopper is in contact with the merchant via telephone.

Allowed:

user_agent

string

length ≤ 256

The full user agent string of the device the customer used to submit the transaction.

sales_description

string

length ≤ 200

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

sca_exemption

string

enum

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

Allowed:

currency_code

string

enum

required

Three-letter ISO 4217 alphabetical currency code. Supported values are: AUD

Allowed:

card_brand

string

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
JCB	Japan Credit Bureau
MASTERCARD	MasterCard
VISA	Visa

encrypted_cvv

string

This is an optional field that is only supported with reuse_token or stored_credentials.reference.

token_preference

object

Contains the properties required to create a token

wallet_type

string

enum

required

Allowed:

wallet_payload

object

required

The encrypted payload object provided by the Wallet on the frontend

sca_compliance_level

string

enum

Defaults to WALLET

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

Allowed:

promo_code

string

A code defined by the merchant that affects the calculation of the total amount.

promo_financing_details

object

Additional details of the special financing offers to customers using private label cards, typically in combination with promo_code field.

tax_indicator

string

enum

Defaults to TAX_NOT_PROVIDED

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

Allowed:

detailed_amount

object

A structure that represents a breakdown all of the different amounts that may appear on a single transaction.

additional_data

object

Additional information for transaction, which may be required in a particular payment request.

Headers

x-vfi-api-idempotencykey

uuid

A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.

Responses

201Wallet Result

400Bad Request

401Unauthorised

403Forbidden

404Not Found

500Internal Server Error