Send Interac
Using this API call you can initiate a new Interac withdrawal (Send). The response will provide the details of the send along with a password which can be used to accept the transaction.
Required fields
Every request needs 2 headers and 5 body fields, and all of them are required. If any is missing or invalid, the request is refused and no withdrawal is created. The security question and answer are optional.
Headers (both required)
x-api-key: your credentials, as<kid>@<api-key>. If it’s missing you get409with messageMissing API key; if it’s wrong,401.Idempotency-Key: a new UUID v4 for every new withdrawal. If it’s missing you get400 MISSING_IDEMPOTENCY; if it’s not a UUID v4,400 INVALID_IDEMPOTENCY_KEY.
Body fields (required)
firstName(string): the receiver’s first name.lastName(string): the receiver’s last name. If either name is missing you get400 MISSING_NAME.payoutEmail(string): the receiver’s email address. Interac sends the payment to it. If it isn’t a valid email address you get422 INVALID_EMAIL.memo(string): your own description of the transaction, 5 to 200 characters. Only letters, digits, spaces and. # , $ @ 'are allowed (no:or-). Otherwise you get400 MISSING_MEMO.amount(number): the amount in CAD, for example25or25.50. Greater than 0, at most9999, with at most 2 decimals and no thousands separator. It also can’t be more than your available balance, otherwise you get400 INSUFFICIENT_FUNDS. If it’s out of range you get422 INVALID_AMOUNT; with more than 2 decimals,422 INVALID_AMOUNT_PRECISION.
Body fields (optional)
securityQuestion(string) andsecurityAnswer(string): send both or neither. If either one is missing, we generate a question and answer for you. The answer needs at least 3 characters and no spaces; otherwise Interac doesn’t accept the withdrawal and it is returned asINCOMPLETE.
Use real email addresses, including when testing in sandbox, and don’t use the word “test” anywhere in an email field. Interac can reject the transaction, or ban the email address, when it sees test or made-up addresses. The example.com addresses on this page are placeholders only. Thank you for your understanding.
The headers must contain a unique Idempotency-Key (UUID v4) in order for the API call to be successfull. If reusing an older key the response will include the details of the transaction where the key was first used. It will not create a new transaction.
This Withdrawal (send) method will have a validation that the receiver will need to provide at the time of the claim of funds with their finnancial institution. The response received will contain a securityAnswer which will need to be decoded and supplied to the receiver.
On the sanbox environment we provide the plainPassword for ease of use, but on the production transactions this will not be present in the response.
Webhook callback example;
A custom securityQuestion and securityAnswer can be created by the requester by specifying both values in the payload. They are optional parameters and the system will generate random ones if they are not specified.
When a custom securityQuestion and securityAnswer pair needs to be created by the requester, both values need to be specified in the payload. Specifying a value just for one of them will render the system to generate a generic pair.
409 Conflict
This endpoint returns 409 Conflict for four different reasons. The HTTP status alone doesn’t tell you which one, so always branch on error.code.
DUPLICATE_PENDING_TRANSACTION_AMOUNT_MISMATCH: the customer already has an open withdrawal for a different amount. See the full explanation below.IDEMPOTENCY_IN_PROGRESS: a request with thisIdempotency-Keyis still being processed. Wait a few seconds, then retry with the same key and the same body.BLACKLISTED: thepayoutEmailis blocked. Don’t retry. Contact NoLimit support if you think this is a mistake.BAD_REQUESTwith messageMissing API key: thex-api-keyheader was not sent. Sendx-api-key: <kid>@<api-key>.
Withdrawals have no check for a reused Idempotency-Key with a different body. If you send a key that was already used, you get the original response back, even if the body is different, and no new withdrawal is created. Always generate a new key for a new withdrawal.
DUPLICATE_PENDING_TRANSACTION_AMOUNT_MISMATCH
The rule
A customer can have only one open withdrawal from you at a time.
- Customer means the
payoutEmail, compared case-insensitively, within your partner account. Withdrawals created by other NoLimit partners don’t count. - One check covers both withdrawal endpoints. An open withdrawal sent with
POST /withdrawal(by email) blocks a newPOST /withdrawal/account(to a bank account) for the samepayoutEmail, and the other way round. - Open means the withdrawal is not final yet:
PENDING,AUTHENTICATED,SENT,FULFILLEDorUNKNOWN. - Withdrawals that are
COMPLETED,REJECTED,DECLINED,CANCELLEDorINCOMPLETEnever block a new withdrawal. - Only withdrawals count here. An open deposit from the same email doesn’t block a withdrawal. Deposits have their own, separate check with the same rules (see
POST /request).
What happens when the customer already has an open withdrawal
Same amount as an open withdrawal: no new withdrawal is created and your balance is not debited again. You get 201 Created with the existing withdrawal.
- The
transactionIdin this response is the original withdrawal’s ID, not theIdempotency-Keyyou just sent. Always store thetransactionIdfrom the response instead of assuming it equals your key. - The response carries the existing withdrawal’s
securityQuestionandsecurityAnswer. Any security question and answer you sent in the new request are ignored. Give the customer the answer from this response. - Your new
Idempotency-Keyis now linked to that existing withdrawal. Replaying it returns the same withdrawal.
Different amount: the request is refused with 409 Conflict:
error.messagelists every open withdrawal for this customer, separated by,, newest first. This is the only place the blocking IDs are returned.- “Mark them as rejected or completed” refers to the customer: they complete the open withdrawal by accepting the money, or reject it by declining it. You can’t close a withdrawal through the API.
What the 409 does not mean
- The open withdrawal has not failed. It is still live, and the customer can still accept it. Don’t mark it as failed on your side.
- No new withdrawal was created, and your balance was not debited. There is no new
transactionIdto track.
What happens to your request
- The
Idempotency-Keyyou sent is released, not stored. You can send the same key again later with the same body. - Every retry for a different amount returns the same
409until all the listed withdrawals are final.
How the open withdrawal ends
Only one of these ends it:
- The customer accepts the money from the Interac email. It becomes
COMPLETED. - The customer declines it, or their bank does. It becomes
DECLINEDorREJECTED. - Nobody acts on it for 30 days, and Interac expires it.
- It was sent to the wrong email address and you ask NoLimit support to cancel it. This is possible only while it is still
SENT, and it becomesCANCELLED.
There is no API endpoint to cancel an open withdrawal.
Recommended handling
- Branch on the code. Treat
DUPLICATE_PENDING_TRANSACTION_AMOUNT_MISMATCHas “the customer has an unaccepted payout”, not as a failed payout. - Find the open withdrawal. Take the transaction ID or IDs from
error.message, or from your own records for that email. CallGET /withdrawal/{id}to get itspostedAmountandstatus. - Tell the customer. For example: “You have a payout of $50.00 waiting. Accept it from the Interac email before requesting another one.”
- Unblock on the final status. When the webhook or
GET /withdrawal/{id}shows a final status, you can send the customer a new withdrawal for any amount.
Avoid the 409 in the first place
- Before sending a withdrawal, check your own records for an open withdrawal to that email.
- If you need to pay the customer more while a payout is still open, wait until the customer accepts it, then send the difference as a new withdrawal.
- Remind customers to accept their payouts, so open withdrawals are resolved sooner.
Order of checks
Checks run in this order. Each one can stop the request before the next:
- API key (
401, or409when the header is missing) - Blacklist (
409 BLACKLISTED) - Body validation, including
DAILY_LIMIT_EXCEEDED(400or422) Idempotency-Key(400, or409 IDEMPOTENCY_IN_PROGRESS)- Withdrawals availability (
403 WITHDRAWAL_UNAVAILABLE) - Open-withdrawal check (
201with the existing withdrawal, or409 DUPLICATE_PENDING_TRANSACTION_AMOUNT_MISMATCH) - Balance (
400 INSUFFICIENT_FUNDS)
Headers
Your credentials, as <kid>@<api-key>.
Request
Your own description of the transaction, 5 to 200 characters. Only letters, digits, spaces and . # , $ @ ' are allowed.
Send together with securityAnswer. If either is missing, a question and answer are generated for you.
Send together with securityQuestion. At least 3 characters, no spaces.