| API Developer Portal

Instant Payments

Our Instant Payments API is the ideal choice for real-time payments within Canada. Powered by Interac e-Transfer, you can quickly send or request money, be sure that funds will be available immediately and track the latest status in real-time. All you need is the recipient’s email or account number.

Overview

Limits:	$25,000/payment $25,000/money request 1 payment/call 1 money request/call Unlimited calls
Countries:	Canada only CAD only
Speed:	Instant deposits (account numbers and emails with Autodeposit) Up to 30 minutes (emails without Autodeposit)
Cut-off times (business days):	Available 24/7

Endpoints Summary

post

/tpp/interac-etransfer/payment-initiation/get-transaction

Obtain Payment Status

post

/tpp/interac-etransfer/payment-initiation/get-request-for-payment-transaction

Obtain Request for Payment Status

post

/tpp/interac-etransfer/payment-initiation/creditor-payment-activation-request

Send Request for Payment

post

/tpp/interac-etransfer/payment-initiation/get-emt-recipient-payment-options/get

Get Payment Option

post

/tpp/interac-etransfer/payment-initiation/customer-credit-transfer-initiation

Send Payment

Payload encryption

For security reasons, all requests to and responses from our Payments APIs need to be encrypted. For detailed instructions, have a look at our encryption process.

View Encryption documentation

Send payments Request money

Get payment status

Check the latest status for your sent payments (CAMT.005). This call returns the current status of a particular payment (Pain.002). Please check our table below for more information about the possible statuses that can be returned.

Note: Instead of checking manually, you can also request automatic alerts by API Webhook, email or text message using our Push Notifications API.

Post

/tpp/interac-etransfer/payment-initiation/get-transaction

Coming Soon

Request

Code Samples

Headers

x-fapi-financial-id

string

x-fapi-customer-last-logged-time

string

x-fapi-customer-ip-address

string

x-fapi-interaction-id required

string

x-fapi-customer-user-agent

string

x-client-id required

string

x-request-id required

string

Authorization required

string

x-app-cat-id

string

true-client-ip required

string

x-crypto-key

string

x-api-key required

string

Body

Response

Table JSON

GPSResponseBody { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Get money request status

Check the latest status for your sent money requests (CAMT.005). This call returns the current status of a particular money request (Pain.002). Please check our table below for more information about the possible statuses that can be returned.

Note: Instead of checking manually, you can also request automatic alerts by API Webhook, email or text message using our Push Notifications API.

Post

/tpp/interac-etransfer/payment-initiation/get-request-for-payment-transaction

Coming Soon

Request

Code Samples

Headers

x-fapi-financial-id

string

x-fapi-customer-last-logged-time

string

x-fapi-customer-ip-address

string

x-fapi-interaction-id required

string

x-fapi-customer-user-agent

string

x-client-id required

string

x-request-id required

string

Authorization required

string

x-app-cat-id

string

true-client-ip required

string

x-crypto-key

string

x-api-key required

string

Body

Response

Table JSON

SPGPSResponseBody { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Send payments Request money

Request money

Quickly request money by email or collect payments within your own application (Pain.013). For requests sent by email, you can choose a custom expiry between 2 hours and 30 days.

This call returns a confirmation if your file passed our format and business validations (Pain.014). If there are no issues, we then forward the request to Interac which sends it as an email to the recipient. No approvals are required.

Note: For a seamless behind-the-scenes integration, you can suppress the traditional Interac emails and use the returned gateway URL in your application instead. This allows your user to complete the payment without leaving your application. You still need to pass the user’s email address even if you decide to suppress Interac emails.

Post

/tpp/interac-etransfer/payment-initiation/creditor-payment-activation-request

Coming Soon

Request

Code Samples

Headers

x-fapi-financial-id

string

x-fapi-customer-last-logged-time

string

x-fapi-customer-ip-address

string

x-fapi-interaction-id required

string

x-fapi-customer-user-agent

string

x-client-id required

string

x-request-id required

string

Authorization required

string

x-app-cat-id

string

true-client-ip required

string

x-crypto-key

string

x-api-key required

string

Body

Response

Table JSON

RFPResponseBody { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Get payment options

Check which payment option is available for the recipient's email or account number (ACMT.023). This must be done before you can send a payment.

The response will confirm if real-time deposits are available and will include a Reference ID needed to create your payment (ACMT.024). Reference IDs expire within 10 minutes.

Note: If you’re trying to send a payment to an email address that is registered for Autodeposit, our response will also include the registered trade name or legal name of the account holder. This helps confirm that you’re paying the right person or company.

Post

/tpp/interac-etransfer/payment-initiation/get-emt-recipient-payment-options/get

Coming Soon

Request

Code Samples

Headers

x-fapi-financial-id

string

x-fapi-customer-last-logged-time

string

x-fapi-customer-ip-address

string

x-fapi-interaction-id required

string

x-fapi-customer-user-agent

string

x-client-id required

string

x-request-id required

string

Authorization required

string

x-app-cat-id

string

true-client-ip required

string

x-crypto-key

string

x-api-key required

string

Body

Response

Table JSON

getPayOptionsResponseBody { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Send payment

Create your payment (Pain.001) before your Reference ID from the previous call expires. For payments sent to an email address without Autodeposit, you can specify a custom expiry period between 1-30 days.

This call returns a confirmation if your file passed our format and business validations (Pain.002). If no issues are found, payments are forwarded to Interac for processing. No approvals are required.

Note: Payments are processed immediately and cannot be scheduled for a future time. They also cannot be modified or cancelled once sent.

Post

/tpp/interac-etransfer/payment-initiation/customer-credit-transfer-initiation

Coming Soon

Request

Code Samples

Headers

x-fapi-financial-id

string

x-fapi-customer-last-logged-time

string

x-fapi-customer-ip-address

string

x-fapi-interaction-id required

string

x-fapi-customer-user-agent

string

x-client-id required

string

x-request-id required

string

Authorization required

string

x-app-cat-id

string

true-client-ip required

string

x-crypto-key

string

x-api-key required

string

Body

Response

Table JSON

SPGPSResponseBody { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}