API Reference
Create a purchase using a wallet
The wallet request object
The credentials required to make payments with a particular wallet provider vary according to the provider used. The type field in the wallet object determines which provider syntax is used. Currently, supported wallets are:
- Apple Pay
- Google Pay
Apple Pay
| Field | Type | Description |
|---|---|---|
type |
String. For Apple Pay, the value will be APPLE, or APPLEPAYWEB if using Apple Pay on the Web. |
Wallet provider identifier |
token |
Object | |
token.paymentData |
Object | Data format is specified by the latest Apple Pay documentation |
token.paymentMethod |
Object | The format is described in the latest Apple Pay documentation, but specifically the ApplePayPaymentMethod page. Required for Apple Pay over EFTPOS. |
Apple Pay transactions over EFTPOS:
- The value for
token.paymentMethod.networkmust be"eftpos"(case-insensitive) to have the transaction routed over EFTPOS. - When the transaction is successfully routed over EFTPOS, the response returned will include the
least_cost_routedfield (within themetadatafield) with the value"true".
Google Pay
| Field | Type | Description |
|---|---|---|
type |
String. For Google Pay, the value will be GOOGLE |
Wallet provider identifier |
token |
Object | Set this field to the object provided by the Google Pay API. This object will contains fields including intermediateSigningKey, protocolVersion, signature, and signedMessage |