API Reference
Supported Operations
- Generate embed URL for wallet linking
- Charge a wallet
- Manage wallets on file (retrieve, set default, delete)
Google Pay Endpoints
Generate Embed URL
POST /api/v2/google-pay/generate-embed-url
Generates a URL for the hosted Google Pay capture iframe.
No additional parameters required beyond authentication.
Charge
POST /api/v2/google-pay/charge
Charges a linked Google Pay wallet.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Amount | decimal | Yes | Charge amount |
| Token | string | Conditional | Google Pay token. Required if no default wallet is set |
| ClientAccountID | string | Optional | Link transaction to a sub-account |
| ClientReferenceNumber | string | Optional | Your internal reference number |
| IdempotencyKey | string | Optional | Unique key to prevent duplicate charges |
| Notes | string | Optional | Internal notes |
Get Charge Transaction
GET /api/v2/google-pay/charge/transaction
Returns details of a single Google Pay charge transaction.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| TransactionID | string | Yes | The transaction ID returned from /google-pay/charge |
Get Wallets on File
GET /api/v2/google-pay
Returns all Google Pay wallets linked to the account.
No additional parameters required.
Set Default Google Pay
POST /api/v2/google-pay/set-my-google-pay
Sets a linked Google Pay wallet as the default for the account.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Token | string | Yes | The Google Pay token to set as default |
Get Default Google Pay
GET /api/v2/google-pay/default-google-pay
Returns the default Google Pay wallet configured for the account.
No additional parameters required.
Delete Google Pay
POST /api/v2/google-pay/delete
Removes a linked Google Pay wallet from the account.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Token | string | Yes | The Google Pay token to delete |
Apple Pay Endpoints
Generate Embed URL
POST /api/v2/apple-pay/generate-embed-url
Generates a URL for the hosted Apple Pay capture iframe.
No additional parameters required beyond authentication.
Charge
POST /api/v2/apple-pay/charge
Charges a linked Apple Pay wallet.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Amount | decimal | Yes | Charge amount |
| Token | string | Conditional | Apple Pay token. Required if no default wallet is set |
| ClientAccountID | string | Optional | Link transaction to a sub-account |
| ClientReferenceNumber | string | Optional | Your internal reference number |
| IdempotencyKey | string | Optional | Unique key to prevent duplicate charges |
| Notes | string | Optional | Internal notes |
Get Charge Transaction
GET /api/v2/apple-pay/charge/transaction
Returns details of a single Apple Pay charge transaction.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| TransactionID | string | Yes | The transaction ID returned from /apple-pay/charge |
Get Wallets on File
GET /api/v2/apple-pay
Returns all Apple Pay wallets linked to the account.
No additional parameters required.
Set Default Apple Pay
POST /api/v2/apple-pay/set-my-apple-pay
Sets a linked Apple Pay wallet as the default for the account.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Token | string | Yes | The Apple Pay token to set as default |
Get Default Apple Pay
GET /api/v2/apple-pay/default-apple-pay
Returns the default Apple Pay wallet configured for the account.
No additional parameters required.
Delete Apple Pay
POST /api/v2/apple-pay/delete
Removes a linked Apple Pay wallet from the account.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Token | string | Yes | The Apple Pay token to delete |
Updated 2 days ago