VOvopay
Interac Endpoints

interac/money-request

This API endpoint is used to create a new Interac money request transaction.

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

post/interac/money-request

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/interac/money-request
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

Client Account ID

ContactIDstring

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

PhoneNumberstring

Customer's phone number. (Digits only - no parentheses or dashes allowed.)

Address1string

Customer's address line 1

Address2string

Customer's address line 2

Citystring

Customer's city

Provincestring

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

Countrystring

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

PostalCodestring

Customer's postal code.

Amountnumber required

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

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.

EmailAddressstring required

Email address the interac money request transaction was sent to.

RecipientNamestring required

The money transfer recipient's name

MessageForRecipientstring

An optional message set by client for the recipient. Maximum 140 characters.

Notesstring

An optional note to associate with the transaction.

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.

GenerateURLboolean

Generate a URL for the money request instead of sending an e-mail.

IdempotencyKeystring

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

GLCodestring

An optional unique identification general ledger code.

TransactionTypeCodestring

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

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

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": "pending",
  "Flagged": "The transaction has been flagged as a potential duplicate."
}

Changes

No recorded changes to this operation across all 1 revision of this API.