interac/bulk-payout

Your account ID

API key for the account

Hashed signature for the e-transfer

Client Account ID

The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.

The amount to debit from the customer's bank account.

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.

Recipient's email address. Either EmailAddress or PhoneNumber must be provided

Recipient's mobile phone number. (Digits only - no parentheses or dashes allowed.). Either EmailAddress or PhoneNumber must be provided

Sender's full name. This is the name that will be used as the sender's name in the notifications to the recipient. If not provided, your VoPay account name will be used.

Recipient's name, as known by the sender.

Recipient's address line 1

Recipient's address line 2

Recipient's city

Recipient's province specified using two character abbreviations (eg. BC, AB)

Recipient's country specified using full country name or ISO 3166-1 alpha-2 code.

Recipient's postal code.

Recipient's language preference. Accepted values: en (English as the default) or fr (French).

1-30 , number of days after which the transfer will be marked as cancelled.

Message to recipient. Set by client for the recipient.

An optional note to associate with the transaction.

An optional reference number which was associated with the transaction.

Security question for the transaction.

Answer to the security question. This can be either a plain text answer or a hashed answer. Hashed answers must have leading and trailing whitespace trimmed, be SHA2 hashed and Base64 encoded. If a hashed answer is provided, the HashSalt input is mandatory.

The salt used to hash the answer. This input is mandatory if a hashed answer is provided.

A unique key which the server can use to recognize and reject subsequent retries of the same request.

The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.

An optional unique identification general ledger code.

CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).

True if the sending was successful, false if it failed

Contains a description of the error if the request failed

The unique ID of the transaction

A message indicating the current transaction status. Statuses are: requested, pending, in progress, successful, failed, cancelled

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