interac/money-request

post

https://earthnode-dev.vopay.com/api/v2/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

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.

PhoneNumber

string

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

Address1

string

Customer's address line 1

Address2

string

Customer's address line 2

City

string

Customer's city

Province

string

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

Country

string

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

PostalCode

string

Customer's postal code.

Amount

number

required

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

Currency

string

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.

EmailAddress

string

required

Email address the interac money request transaction was sent to.

RecipientName

string

required

The money transfer recipient's name

MessageForRecipient

string

An optional message 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. This can only be used to look up the transaction if it was a unique ID.

GenerateURL

boolean

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

IdempotencyKey

string

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

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