Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Debit Card Endpoints

debit-card/oct/transaction

This method is used to look up and return the full details on a single OCT transaction. OCT transactions sends money from your VoPay account directly onto the customer's debit card.

get/debit-card/oct/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, rejected

TransactionDateTimestring date-time required

The timestamp when the transaction was created

Amountnumber required

The dollar amount of the transaction. This is the amount that was sent to the customer's debit card.

Currencystring required

The currency for the transaction.

PushToCardTokenstring required

A unique token who has the card information. Note. For security purposes we do not store the customer debit card information.

Countrystring required

Customer's Country specified using full country name or ISO 3166-1 alpha-2 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.

GLCodestring required

General ledger code.

TransactionTypeCodestring required

CPA transaction code.

Example response

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