v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Interac Endpoints

interac/bulk-payout

This endpoint is used to create an Interac e-Transfer bulk payout transaction for sending funds.

If a ClientAccountID is provided, the client account's first/last name, and email address will be used for the transaction.

post/interac/bulk-payout

Response

Successboolean required

True if the sending 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

Flaggedstring

Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.

Example response

{
  "Success": true,
  "TransactionStatus": "successful",
  "Flagged": "The transaction has been flagged as a potential duplicate."
}