---
title: "interac/bulk-payout"
method: POST
path: "/interac/bulk-payout"
tags: ["Interac Endpoints"]
---

# interac/bulk-payout

`POST /interac/bulk-payout`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/interac/bulk-payout`
- Auth: none declared

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.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the e-transfer
  - `ClientAccountID` string: Client Account ID
  - `ContactID` string: The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.
  - `Amount` number, required: The amount to debit from the customer's bank account.
  - `Currency` string: 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.
  - `EmailAddress` string: Recipient's email address. Either EmailAddress or PhoneNumber must be provided
  - `PhoneNumber` string: Recipient's mobile phone number. (Digits only - no parentheses or dashes allowed.). Either EmailAddress or PhoneNumber must be provided
  - `SenderName` string: 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.
  - `RecipientName` string, required: Recipient's name, as known by the sender.
  - `Address1` string: Recipient's address line 1
  - `Address2` string: Recipient's address line 2
  - `City` string: Recipient's city
  - `Province` string: Recipient's province specified using two character abbreviations (eg. BC, AB)
  - `Country` string: Recipient's country specified using full country name or ISO 3166-1 alpha-2 code.
  - `PostalCode` string: Recipient's postal code.
  - `Language` string: Recipient's language preference. Accepted values: en (English as the default) or fr (French).
  - `CancellationPeriod` integer: 1-30 , number of days after which the transfer will be marked as cancelled.
  - `Memo` string: Message to recipient. Set by client for the recipient.
  - `Notes` string: An optional note to associate with the transaction.
  - `ClientReferenceNumber` string: An optional reference number which was associated with the transaction.
  - `Question` string, required: Security question for the transaction.
  - `Answer` string, required: 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.
  - `HashSalt` string: The salt used to hash the answer. This input is mandatory if a hashed answer is provided.
  - `IdempotencyKey` string: A unique key which the server can use to recognize and reject subsequent retries of the same request.
  - `ParentTransactionID` string: 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.
  - `GLCode` string: An optional unique identification general ledger code.
  - `TransactionTypeCode` string: 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).

## Response `200`

- object
  - `Success` boolean, required: True if the sending was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `TransactionID` integer, required: The unique ID of the transaction
  - `TransactionStatus` string, required: A message indicating the current transaction status. Statuses are: requested, pending, in progress, successful, failed, cancelled
  - `Flagged` string: Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.

---

[API](https://skmtc.dev/vopay/apis/payment-rails.md) - [All operations](https://skmtc.dev/vopay/apis/payment-rails/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-rails/revisions/d6fe8969ddcf?raw)