v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Interac Endpoints

interac/money-request/transaction

This endpoint is used to look up details on a single Interac money request transaction. This endpoint can be used to return transactions created with the API, or transactions submitted via SFTP batch file.

get/interac/money-request/transaction

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionIDinteger

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

ClientReferenceNumberstring

An optional reference number which was associated with the transaction. This can only be used to look up the transaction if it was a unique 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: requested, pending, 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 fund transaction. This is the amount that was withdrawn from the customer's bank account.

Currencystring required

The currency for the transaction( generally CAD).

HoldAmountnumber required

Indicates if any of the funds that were credited to your account are still being held.

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.

BatchFileNamestring required

The filename for the batch that the request was submitted in, if the transaction was created as part of a CSV batch.

Namestring required

Customer's name

Emailstring required

Email address the interac money request transaction was sent to.

PhoneNumberstring required

Customer's phone number

RecipientNamestring required

The money transfer recipient's name

MessageForRecipientstring required

An optional message set by client for the recipient

ClientReferenceNumberstring required

An optional reference number which was associated with the transaction. This can only be used to look up the transaction if it was a unique ID.

ConfirmationNumberstring required

The bank confirmation number for the interac transaction.

ProcessingDatestring date-time required

The timestamp when the transaction was processed and the money request email was sent.

GLCodestring required

General ledger code.

TransactionTypeCodestring required

CPA transaction code.

MoneyRequestURLstring required

Interac Money Request URL.

Example response

{
  "Success": true,
  "TransactionStatus": "pending",
  "FailureReason": "{Reason}",
  "TransactionDateTime": "2019-11-02 12:00:00",
  "Currency": "CAD",
  "LastModified": "2019-11-12 01:00:00",
  "BatchFileName": "BMO_112567",
  "Name": "John Doe",
  "Email": "johndoe@email.com",
  "PhoneNumber": "6041235678",
  "RecipientName": "John Doe",
  "MessageForRecipient": "Message",
  "ConfirmationNumber": "112233",
  "ProcessingDate": "2019-11-19 12:00:00",
  "GLCode": "4300",
  "TransactionTypeCode": "999"
}