Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Digital Wallet Endpoints

apple-pay/charge/transaction

This method is used to look up and return the full details on a single Apple Pay transaction. Apple Pay transactions take money out of the customer's card and deposit them into your VoPay account.

get/apple-pay/charge/transaction

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionIDinteger required

Account transaction ID

Response

Successboolean required

true if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

TransactionIDinteger required

The unique ID of the transaction

TransactionStatusstring required

A message indicating the current transaction status. Statuses are: successful, failed, cancelled, settled

TransactionDateTimestring date-time required

The timestamp when the transaction was created

Amountnumber required

The dollar amount of the Apple Pay transaction. This is the amount that was withdrawn from the customer's card.

Currencystring required

The currency for the transaction.

ApplePayTokenstring required

A unique token who has the Apple Pay wallet information. Note. For security purposes we do not store the customer credit card information.

Countrystring required

Customer's Country specified using full country name or ISO 3166-1 alpha-2 code.

GLCodestring required

General ledger code.

TransactionTypeCodestring required

CPA transaction code.

LastModifiedstring date-time required

This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.

Example response

{
  "Success": true,
  "TransactionStatus": "pending",
  "TransactionDateTime": "2019-11-01 12:00:00",
  "Currency": "CAD",
  "ApplePayToken": "ACBDF-GAFSHD-AHBS-123456",
  "Country": "CA",
  "GLCode": "4300",
  "TransactionTypeCode": "999",
  "LastModified": "2019-11-03 01:00:00"
}