Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Credit Card Endpoints

credit-card/charge/transaction

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

get/credit-card/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 credit card transaction. This is the amount that was withdrawn from the customer's credit card.

Currencystring required

The currency for the transaction.

CreditCardTokenstring required

A unique token who has the credit card 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.

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.

TransactionTypeCodestring required

CPA transaction code.

Example response

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