v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Interac Endpoints

interac/bulk-payout/transaction

This endpoint is used to look up details on an Interac e-Transfer bulk payout transaction.

get/interac/bulk-payout/transaction

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the e-transfer

ClientReferenceNumberstring

An optional reference number which was associated with the transaction.

TransactionIDstring

Unique ID of the fund transaction. Either this or ClientReferenceNumber is required.

Response

Successboolean required

True if the e-transfer 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: requested, pending, in progress, successful, failed, cancelled.

FailureReasonstring required

A message in case of transaction failure indicating why it failed.

TransactionDateTimestring date-time required

The timestamp when the transaction was received.

Amountnumber required

The dollar amount of the transaction.

Currencystring required

3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency (generally CAD). NOTE: Currently the eft/fund API endpoint only supports CAD transactions.

HoldAmountnumber required

Indicates if any of the funds from the transaction are still being held.

LastModifiedstring date-time required

This timestamp indicates when the transaction record was last modified.

SenderNamestring required

Sender's full name. This is the name that will be used as the sender's name in the notifications to the recipient.

RecipientNamestring required

Recipient's name, as known by the sender.

EmailAddressstring required

Recipient's email address.

Memostring required

Message to recipient.

ClientReferenceNumberstring required

An optional reference number which was associated with the transaction.

ConfirmationNumberstring required

The bank confirmation number for the Interac transaction.

ProcessingDatestring date-time required

The timestamp when the transaction was processed and the e-transfer email was sent.

CancellationPeriodinteger required

The number of days after which the transfer will be marked as cancelled.

GLCodestring required

General ledger code.

TransactionTypeCodestring required

CPA transaction code.

Example response

{
  "Success": true,
  "TransactionStatus": "pending",
  "TransactionDateTime": "2019-11-02 12:00:00",
  "Currency": "CAD",
  "LastModified": "2019-11-12 12:00:00",
  "SenderName": "John Doe",
  "RecipientName": "Max Doe",
  "EmailAddress": "maxdoe@email.com",
  "ConfirmationNumber": "11223344",
  "ProcessingDate": "2019-12-01 12:00:00",
  "GLCode": "4300",
  "TransactionTypeCode": "999"
}