BMO Instant Payments (Interac) API
Sends and receives real-time Interac e-Transfer instant payments in Canada with live status, request-for-money, and autodeposit flows. OAuth 2.0 plus client API key.
BMO Instant Payments (Interac) API is one of 11 APIs that BMO publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments, Instant Payments, Interac, and Canada. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 6 operations across 6 paths, organized into 6 resource areas, and defines 310 schemas. It is described by OpenAPI 3.0.1, at version 4.3.0.
Requests are made against a single base URL, https://open-api-sit.bmogc.net/open-banking2/commercial-sb.
6 operations
6 paths
310 schemas
6 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
BMO Instant Payments (Interac) API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as x-api-key (api-key-1).
It supports OAuth 2.0 (OAuth) using the authorizationCode flow, exposing 3 scopes.
Paths & Operations 6
Across 6 paths, the API surfaces 6 operations — 6 POST. They span 6 resource areas: TPP-EMTGetTransaction, TPP-EMTGetRequestForPaymentTransaction, TPP-EMTCreditorPaymentActivationRequest, TPP-EMTRecipientPaymentOptions, TPP-EMTCustomerCreditTransferInitiation, TPP-EMTCustomerCancelTransferInitiation. Each is listed below with its method, path, parameters, and response codes.
TPP-EMTGetTransaction 1
Payment Status Enquiry
POST
/tpp/interac-etransfer/payment-initiation/get-transaction
Obtain Payment Status
TPP-EMTGetRequestForPaymentTransaction 1
Request for Payment Status Enquiry
POST
/tpp/interac-etransfer/payment-initiation/get-request-for-payment-transaction
Obtain Request for Payment Status
TPP-EMTCreditorPaymentActivationRequest 1
Request for Payment initiation
POST
/tpp/interac-etransfer/payment-initiation/creditor-payment-activation-request
Send Request for Payment
TPP-EMTRecipientPaymentOptions 1
Retrieve payment options
POST
/tpp/interac-etransfer/payment-initiation/get-emt-recipient-payment-options/get
Get Payment Option
TPP-EMTCustomerCreditTransferInitiation 1
Send Payment
POST
/tpp/interac-etransfer/payment-initiation/customer-credit-transfer-initiation
Send Payment
TPP-EMTCustomerCancelTransferInitiation 1
Cancel Payment
POST
/tpp/interac-etransfer/payment-execution/customer-payment-cancellation-request
Cancellation of payment
Schemas 310
The contract defines 310 schemas that model the data the API accepts and returns. The most detailed are CreditTransferTransaction34 (25 properties), PaymentInstruction30 (16 properties), PostalAddress24 (16 properties), OriginalTransactionReference28 (16 properties). Each schema is shown below with its type and property counts.
cancelPaymentRequestBody
object
1 property
customerPaymentCancellationRequestV08
object
1 property
1 required
CustomerPaymentCancellationRequestV08
object
4 properties
2 required
CaseAssignment5
object
4 properties
4 required
ControlData1
object
1 property
1 required
UnderlyingTransaction24
object
2 properties
OriginalGroupHeader15
object
4 properties
2 required
OriginalPaymentInstruction34
object
6 properties
1 required
PaymentCancellationReason5
object
2 properties
CancellationReason33Choice
object
2 properties
ExternalCancellationReason1Code
string
GroupCancellationIndicator
boolean
OriginalGroupInformation29
object
3 properties
2 required
PaymentTransaction109
object
9 properties
Case5
object
2 properties
2 required
OriginalTransactionReference28Req
object
12 properties
AmountType4ChoiceCanc
object
2 properties
EquivalentAmount2Canc
object
2 properties
2 required
SPRequestBody
object
1 property
customerCreditTransferInitiation
object
1 property
1 required
GroupHeader85
object
5 properties
4 required
Max35Text
string
Specifies a character string with a maximum length of 35 characters.
ISODateTime
string
Max128Text
string
Specifies a character string with a maximum length of 128 characters.
Max15NumericText
string
Specifies a numeric string with a maximum length of 15 digits.
DecimalNumber
string
PartyIdentification135
object
5 properties
Max140Text
string
Specifies a character string with a maximum length of 140 characters.
PostalAddress24
object
16 properties
AddressType3Choice
object
2 properties
AddressType2Code
string
GenericIdentification30
object
3 properties
2 required
Exact4AlphaNumericText
string
Specifies an alphanumeric string with a length of 4 characters.
Max70Text
string
Specifies a character string with a maximum length of 70characters.
Max16Text
string
Specifies a character string with a maximum length of 16 characters.
CountryCode
string
Party38Choice
object
2 properties
OrganisationIdentification29
object
3 properties
AnyBICDec2014Identifier
string
LEIIdentifier
string
GenericOrganisationIdentification1
object
3 properties
1 required
OrganisationIdentificationSchemeName1Choice
object
2 properties
ExternalOrganisationIdentification1Code
string
PersonIdentification13
object
2 properties
DateAndPlaceOfBirth1
object
4 properties
3 required
ISODate
string
GenericPersonIdentification1
object
3 properties
1 required
PersonIdentificationSchemeName1Choice
object
2 properties
ExternalPersonIdentification1Code
string
Contact4
object
12 properties
NamePrefix2Code
string
PhoneNumber
string
The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a '+' followed by the country code…
Max2048Text
string
Specifies a character string with a maximum length of 2048 characters.
OtherContact1
object
2 properties
1 required
Max4Text
string
Specifies a character string with a maximum length of 4 characters.
PreferredContactMethod1Code
string
BranchAndFinancialInstitutionIdentification6
object
2 properties
1 required
FinancialInstitutionIdentification18
object
6 properties
BICFIDec2014Identifier
string
ClearingSystemMemberIdentification2
object
2 properties
1 required
ClearingSystemIdentification2Choice
object
2 properties
ExternalClearingSystemIdentification1Code
string
GenericFinancialIdentification1
object
3 properties
1 required
FinancialIdentificationSchemeName1Choice
object
2 properties
ExternalFinancialInstitutionIdentification1Code
string
BranchData3
object
4 properties
PaymentInstruction30
object
16 properties
7 required
PaymentMethod3Code
string
PaymentTypeInformation26
object
4 properties
Priority2Code
string
ServiceLevel8Choice
object
2 properties
ExternalServiceLevel1Code
string
LocalInstrument2Choice
object
2 properties
ExternalLocalInstrument1Code
string
CategoryPurpose1Choice
object
2 properties
ExternalCategoryPurpose1Code
string
DateAndDateTime2Choice
object
2 properties
CashAccount38
object
5 properties
1 required
AccountIdentification4Choice
object
2 properties
IBAN2007Identifier
string
GenericAccountIdentification1
object
3 properties
1 required
Max34Text
string
Specifies a character string with a maximum length of 34 characters.
AccountSchemeName1Choice
object
2 properties
ExternalAccountIdentification1Code
string
CashAccountType2Choice
object
2 properties
ExternalCashAccountType1Code
string
ActiveOrHistoricCurrencyCode
string
ProxyAccountIdentification1
object
2 properties
1 required
ProxyAccountType1Choice
object
2 properties
ExternalProxyAccountType1Code
string
ChargeBearerType1Code
string
CreditTransferTransaction34
object
25 properties
2 required
PaymentIdentification6
object
3 properties
1 required
UUIDv4Identifier
string
AmountType4Choice
object
2 properties
ActiveOrHistoricCurrencyAndAmount
object
2 properties
CurrencyAmountType
number
EquivalentAmount2
object
2 properties
2 required
ExchangeRate1
object
4 properties
BaseOneRate
string
ExchangeRateType1Code
string
Cheque11
object
12 properties
ChequeType2Code
string
NameAndAddress16
object
2 properties
2 required
ChequeDeliveryMethod1Choice
object
2 properties
ChequeDelivery1Code
string
InstructionForCreditorAgent1
object
2 properties
InstructionForDebtorAgent1
object
2 properties
Instruction3Code
string
Purpose2Choice
object
2 properties
ExternalPurpose1Code
string
RegulatoryReporting3
object
3 properties
RegulatoryReportingType1Code
string
RegulatoryAuthority2
object
2 properties
StructuredRegulatoryReporting3
object
6 properties
Max10Text
string
Specifies a character string with a maximum length of 10 characters.
TaxInformation8
object
4 properties
TaxParty1
object
3 properties
TaxParty2
object
4 properties
TaxAuthorisation1
object
2 properties
Number
string
TaxRecord2
object
5 properties
TaxPeriod2
object
3 properties
TaxRecordPeriod1Code
string
DatePeriod2
object
2 properties
2 required
TaxAmount2
object
1 property
TaxRecordDetails2
object
2 properties
1 required
RemittanceLocation7
object
2 properties
RemittanceLocationData1
object
3 properties
1 required
RemittanceLocationMethod2Code
string
RemittanceInformation16
object
2 properties
StructuredRemittanceInformation16
object
8 properties
ReferredDocumentInformation7
object
4 properties
ReferredDocumentType4
object
2 properties
1 required
ReferredDocumentType3Choice
object
2 properties
DocumentType6Code
string
DocumentLineInformation1
object
3 properties
1 required
DocumentLineIdentification1
object
3 properties
DocumentLineType1
object
2 properties
1 required
DocumentLineType1Choice
object
2 properties
ExternalDocumentLineType1Code
string
RemittanceAmount3
object
6 properties
DiscountAmountAndType1
object
2 properties
1 required
DiscountAmountType1Choice
object
2 properties
ExternalDiscountAmountType1Code
string
TaxAmountAndType1
object
2 properties
1 required
TaxAmountType1Choice
object
2 properties
ExternalTaxAmountType1Code
string
DocumentAdjustment1
object
4 properties
1 required
CreditDebitCode
string
RemittanceAmount2
object
6 properties
CreditorReferenceInformation2
object
2 properties
CreditorReferenceType2
object
2 properties
1 required
CreditorReferenceType1Choice
object
2 properties
DocumentType3Code
string
TaxInformation7
object
11 properties
Garnishment3
object
8 properties
1 required
TrueFalseIndicator
boolean
SupplementaryData1
object
1 property
1 required
Max350Text
string
Specifies a character string with a maximum length of 350 characters.
SupplementaryDataEnvelope1
object
1 property
CustomerCreditTransferInitiationV09
object
3 properties
2 required
GarnishmentType1
object
2 properties
1 required
GarnishmentType1Choice
object
2 properties
ExternalGarnishmentType1Code
string
SPGPSResponseBody
object
1 property
GPSResponseBody
object
1 property
customerPaymentStatusReportV10
object
1 property
1 required
GroupHeader86
object
3 properties
2 required
OriginalGroupHeader17
object
8 properties
2 required
ExternalPaymentGroupStatus1Code
string
StatusReasonInformation12
object
3 properties
StatusReason6Choice
object
2 properties
ExternalStatusReason1Code
string
Max105Text
string
Specifies a character string with a maximum length of 105 characters.
NumberOfTransactionsPerStatus5
object
3 properties
2 required
ExternalPaymentTransactionStatus1Code
string
OriginalPaymentInstruction32
object
8 properties
1 required
PaymentTransaction105
object
10 properties
ActiveCurrencyAndAmount
object
2 properties
ActiveCurrencyCode
string
OriginalTransactionReference28
object
16 properties
creditorAccount
object
1 property
1 required
accountIdentification
object
1 property
otherAccountIdentification
object
1 property
1 required
debtorAccount
object
1 property
1 required
debtorAgent
object
1 property
1 required
agentFinancialInstitution
object
1 property
agentMemberIdentification
object
1 property
creditorAgent
object
1 property
1 required
PaymentTypeInformation27
object
6 properties
ClearingChannel2Code
string
SequenceType3Code
string
PaymentMethod4Code
string
PercentageRate
string
Party40Choice
object
2 properties
CustomerPaymentStatusReportV10
object
3 properties
2 required
GPSRequestBody
object
1 property
getTransactionV08
object
1 property
1 required
MessageHeader9
object
3 properties
1 required
RequestType4Choice
object
3 properties
ExternalPaymentControlRequestType1Code
string
ExternalEnquiryRequestType1Code
string
GenericIdentification1
object
3 properties
1 required
TransactionQuery5
object
2 properties
QueryType2Code
string
TransactionCriteria5Choice
object
2 properties
TransactionCriteria8
object
2 properties
TransactionSearchCriteria8
object
3 properties
SystemSearch4
object
4 properties
ClearingSystemIdentification3Choice
object
2 properties
ExternalCashClearingSystem1Code
string
PaymentSearch8
object
13 properties
Priority1Choice
object
1 property
1 required
PaymentIdentification6Choice
object
5 properties
QueueTransactionIdentification1
object
2 properties
2 required
LongPaymentIdentification2
object
7 properties
4 required
ShortPaymentIdentification2
object
3 properties
3 required
InstructionStatusSearch5
object
2 properties
PaymentStatusCodeSearch2Choice
object
3 properties
ActiveOrHistoricAmountRange2Choice
object
2 properties
impliedCurrencyAndAmountRange1
object
2 properties
1 required
ActiveOrHistoricCurrencyAndAmountRange2
object
2 properties
2 required
ImpliedCurrencyAmountRange1Choice
object
5 properties
FromToAmountRange1
object
2 properties
2 required
AmountRangeBoundary1
object
2 properties
2 required
ImpliedCurrencyAndAmount
object
1 property
1 required
YesNoIndicator
boolean
PaymentOrigin1Choice
object
1 property
1 required
PendingStatus4Code
string
FinalStatusCode
string
CashPaymentStatus2Code
string
PaymentTransactionParty3
object
6 properties
DateAndDateTimeSearch3Choice
object
2 properties
DateTimePeriod1Choice
object
3 properties
DateTimePeriod1
object
2 properties
2 required
DatePeriodSearch1Choice
object
4 properties
Max4AlphaNumericText
string
Specifies an alphanumeric string with a maximum length of 4 characters.
Priority5Code
string
GetTransactionV08
object
3 properties
1 required
ImpliedCurrencyAmount
object
getPayOptionsRequestBody
object
1 property
gpoRequestBody
object
1 property
1 required
document
object
1 property
1 required
IdentificationVerificationRequestV03
object
3 properties
2 required
IdentificationVerification4
object
2 properties
2 required
IdentificationInformation4
object
3 properties
CashAccount40
object
5 properties
supplementaryData
object
2 properties
1 required
IdentificationAssignment3
object
6 properties
4 required
getPayOptionsResponseBody
object
1 property
gpoResponseBody
object
1 property
1 required
document1
object
1 property
1 required
IdentificationVerificationReportV03
object
4 properties
2 required
MessageIdentification7
object
3 properties
VerificationReason1Choice
object
2 properties
VerificationReport4
object
5 properties
2 required
RFPRequestBody
object
1 property
creditorPaymentActivationRequestV07
object
1 property
1 required
GroupHeader78
object
5 properties
4 required
PaymentInstruction31
object
11 properties
5 required
PaymentMethod7Code
string
CreditTransferTransaction35
object
15 properties
5 required
Document12
object
7 properties
5 required
DocumentType1Choice
object
1 property
1 required
ExternalDocumentType1Code
string
DocumentFormat1Choice
object
2 properties
ExternalDocumentFormat1Code
string
Max10MbBinary
string
PaymentCondition1
object
3 properties
3 required
CreditorPaymentActivationRequestV07
object
3 properties
2 required
SupplementaryDataRfp
object
1 property
1 required
SupplementaryDataGPS
object
1 property
1 required
SupplementaryDataEnvelopeGPS
object
1 property
SupplementaryDataEnvelopeRfp
object
1 property
RFPResponseBody
object
1 property
creditorPaymentActivationRequestStatusReportV07
object
1 property
1 required
GroupHeader87
object
5 properties
3 required
OriginalGroupInformation30
object
8 properties
2 required
OriginalPaymentInstruction31
object
2 properties
1 required
PaymentTransaction104
object
8 properties
PaymentConditionStatus1
object
3 properties
2 required
OriginalTransactionReference29
object
4 properties
CreditorPaymentActivationRequestStatusReportV07
object
3 properties
2 required
SupplementaryDataRfpResp
object
1 property
1 required
SupplementaryDataEnvelopeRfpResp
object
cancelPaymentResponseBody
object
1 property
resolutionOfInvestigationV09
object
1 property
1 required
ResolutionOfInvestigationV09
object
6 properties
2 required
SupplementaryData1Canc
object
2 properties
1 required
SupplementaryDataEnvelope1Canc
object
2 properties
1 required
PaymentTransaction107
object
6 properties
1 required
OriginalTransactionReference28Resp
object
11 properties
UnderlyingTransaction22
object
3 properties
PaymentTransaction102
object
10 properties
ResolutionData1
object
4 properties
Charges7
object
2 properties
2 required
OriginalPaymentInstruction30
object
6 properties
1 required
PaymentTransaction103
object
7 properties
CancellationIndividualStatus1Code
string
NumberOfCancellationsPerStatus1
2 required
OriginalGroupHeader14
object
6 properties
2 required
CancellationStatusReason4
object
2 properties
CancellationStatusReason3Choice
object
2 properties
ExternalPaymentCancellationRejection1Code
string
GroupCancellationStatus1Code
string
InvestigationStatus5Choice
object
2 properties
ModificationStatusReason1Choice
object
1 property
1 required
ExternalInvestigationExecutionConfirmation1Code
string
Problem
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from BMO 10
Other APIs BMO publishes across the network.
BMO Account Validation API
BMO Account Information API
BMO ACH Payments API
BMO Wire Payments (U.S.) API
BMO Wire Payments (Canada) API
BMO EFT Payments API
BMO Image Retrieval API
BMO Authorize & Token API
BMO Client Data Encryption Key API
BMO Push Notification API
#Payments#Instant Payments#Interac#Canada
Where this information came from
This is an independent, third-party profile of BMO Instant Payments (Interac) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.