API Reference

apple-pay/charge

post
https://earthnode-dev.vopay.com/api/v2/apple-pay/charge

This endpoint is to create a Apple Pay transaction to fund your VoPay account, charging the amount specified to the card linked to the provided Apple Pay Token.

If a ClientAccountID is provided, the client account's default Apple Pay wallet will be used for the transaction.

Note: You must first generate a ApplePayToken using the /apple-pay/generate-embed-url endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

string

Client Account ID

string

The ID of the contact to use for this transaction. The contacts payment method associated with this transaction type will be used.

string
required

The token identifying the Apple Pay wallet to charge (returned from /apple-pay/generate-embed-url).

number
required

The amount to charge from the customer's Apple Pay wallet.

string

3 character currency code for the currency to be charged to the customer's Apple Pay wallet. If this is not specified the transaction will use the account's local currency.

string

Customer's country specified using full country name or ISO 3166-1 alpha-2 code. If this is not specified the transaction will use the local country.

string

A unique key which the server can use to recognize and reject subsequent retries of the same request.

string

An optional unique identification general ledger code.

string

CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).

Response

Updated 11 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago