Service de virement automatisé (SVA)

Swagger

Notre interface API Service de virement automatisé (SVA) est un moyen rapide et économique d'envoyer et de percevoir des paiements au Canada. Vous pouvez soumettre des lots comprenant jusqu'à 50 paiements à tout moment et les suivre grâce à des mises à jour en temps réel sur leur état.

Aperçu

Limites :	99 999 999,99 $/paiement 50 paiements/appel (doivent être du même type et devise) Jusqu'à 100 jours à l'avance Appels illimités
Pays :	Canada seulement CAD et USD (devise du compte destinataire doit correspondre)
Vitesse :	Le jour même (si pris en charge par la banque destinataire) 1-2 jours ouvrables (selon la banque destinataire)
Heures limites (jours ouvrables) :	Paiements en CAD 19 h 00 HE Paiements en USD 05 h 00 HE

Vue rapprochée

Paiements en masse économiques – Vous pouvez regrouper jusqu'à 50 paiements en un seul appel et réaliser des économies. Les paiements en lot doivent être du même type et devise.

Gestion simplifiée des destinataires – Vous n'avez pas besoin d'ajouter des destinataires, de gérer les détails des comptes ou de créer des modèles. Il vous suffit de récupérer les dernières données directement dans votre application lorsque vous en avez besoin.

Confirmation instantanée – Lorsque vous soumettez des paiements, vous recevez une réponse en quelques secondes. Vous pouvez ainsi résoudre les problèmes immédiatement, sans avoir à attendre les rapports traditionnels de retour ou de rejet à la fin de la journée.

Gestion des paiements en ligne – Après avoir soumis vos paiements, vous pouvez toujours les gérer dans les Services bancaires en ligne pour entreprises. Il vous suffit d'ouvrir une session pour annuler, modifier ou supprimer des paiements SVA.

Suivi en temps réel – Demandez des mises à jour sur l'état de vos paiements créés ou recevez des alertes automatiques par API, courriel ou message texte à l'aide de notre interface API Notifications push. Les paiements sont suivis jusqu'à ce qu'ils quittent BMO.

Endpoints Summary

post

/tpp/eft/payment-initiation/customer-credit-transfer-initiation

Send Payment Credit

post

/tpp/eft/payment-initiation/customer-direct-debit-initiation

Send Payment Debit

post

/tpp/eft/payment-initiation/get-transaction-status/get

Obtain Payment Status

post

/tpp/eft/customer-access-entitlement/commercial-user-access-arrangement/get

Obtain Service Agreement List

Chiffrement de la charge utile

Pour des raisons de sécurité, toutes les demandes envoyées à nos interfaces API de paiement et toutes les réponses provenant de celles-ci doivent être chiffrées. Pour obtenir des instructions détaillées, consultez notre processus de chiffrement.

Voir la documentation sur le chiffrement

Envoyer des paiements

Pour réduire le nombre d'appels nécessaires, vous pouvez soumettre un lot de 50 paiements maximum au cours d'un même appel. Ceux-ci doivent être du même type (crédits SVA) et devise (CAD ou USD), mais vous pouvez mélanger les paiements courants et les paiements prévus (jusqu'à 100 jours à l'avance).

Créez vos paiements (Pain.001) en indiquant le type et toutes les informations obligatoires, comme indiqué dans le document « Spécifications » en haut de la page. Cela inclut un identifiant unique de bout en bout pour chaque paiement de votre lot, qui doit être alphanumérique, comporter jusqu'à 35 caractères et ne pas avoir été utilisé pour un autre paiement au cours des 180 derniers jours.

Une fois soumis, nous validerons vos paiements et nous vous communiquerons les résultats (Pain.002). Si tout est en ordre, nous traiterons vos paiements. Aucune autorisation n'est requise. Toutes les 30 minutes, nous regroupons vos paiements dans un fichier de paiement. Vous pouvez récupérer le numéro du fichier de paiement à l'aide du point de terminaison « Obtenir l’état du paiement ».

Remarque : À l'aide du numéro de fichier de paiement, vous pouvez retrouver vos paiements générés par l'interface API dans les Services bancaires en ligne pour entreprises et les modifier ou les annuler. Les corrections et les resoumissions sont possibles dans les Services bancaires en ligne pour entreprises, mais nous vous recommandons plutôt de créer de nouveaux paiements à l'aide de l'interface API.

Post

/tpp/eft/payment-initiation/customer-credit-transfer-initiation

Essayez-le

Request

Code Samples

Headers

x-fapi-financial-id required

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

x-bmo-id-token

string

Body

Response

Table JSON

SECURE { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Percevoir des paiements

Vous pouvez également percevoir un lot de 50 paiements maximum au cours d'un même appel pour réduire le nombre d'appels nécessaires. Ceux-ci doivent être du même type (débits SVA) et devise (CAD ou USD), mais vous pouvez mélanger les paiements courants et les paiements prévus (jusqu'à 100 jours à l'avance).

Créez vos paiements (Pain.008) en indiquant le type et toutes les informations obligatoires, comme indiqué dans le document « Spécifications » en haut de la page. Cela inclut un identifiant unique de bout en bout pour chaque paiement de votre lot, qui doit être alphanumérique, comporter jusqu'à 35 caractères et ne pas avoir été utilisé pour un autre paiement au cours des 180 derniers jours.

Post

/tpp/eft/payment-initiation/customer-direct-debit-initiation

Essayez-le

Request

Code Samples

Headers

x-fapi-financial-id required

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

x-bmo-id-token

string

Body

Response

Table JSON

SECURE { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Obtenir l'état du paiement

Vérifiez le dernier état de vos paiements envoyés (CAMT.005) et récupérez le numéro de fichier de paiement SVA que vous pouvez utiliser pour gérer vos paiements dans les Services bancaires en ligne pour entreprises. Cet appel renvoie le numéro de fichier de paiement SVA et l'état actuel d'un lot de paiements particulier (Pain.002) jusqu'à ce qu'il quitte BMO. Veuillez consulter le tableau ci-dessous pour plus d'informations sur les états possibles qui peuvent être renvoyés.

Bien que les paiements SVA générés via l'interface API puissent être gérés dans les Services bancaires en ligne pour entreprises, ils ne seront pas pris en compte dans nos rapports SVA. Pour obtenir des rapports complets, veuillez utiliser l'appel « Obtenir l’état du paiement » afin de générer vos propres rapports pour ces paiements.

Remarque : Au lieu de vérifier manuellement, vous pouvez également demander des alertes automatiques par API Webhook, courriel ou message texte à l'aide de notre interface API Notifications push.Si vous avez configuré les alertes BMO dans les Services bancaires en ligne pour les entreprises, celles-ci se déclencheront également.

Post

/tpp/eft/payment-initiation/get-transaction-status/get

Essayez-le

Request

Code Samples

Headers

x-fapi-financial-id required

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

x-bmo-id-token

string

Body

Response

Table JSON

SECURE { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Obtenir les numéros de compte SVA

C'est un appel facultatif permettant de récupérer la liste des numéros de compte SVA disponibles qui ont reçu l'autorisation d'utiliser l'interface API en format .json.

Les numéros de compte SVA servent d'alias pour vos comptes BMO et les types de paiement SVA pouvant être utilisés. Les numéros de compte SVA d’ordres permanents pour les paiements récurrents ne sont pas pris en charge par notre interface API. Vous devrez plutôt soumettre chaque instance de la série individuellement.

Remarque : Ce point de terminaison n'est actuellement pas disponible pour les tests dans nos environnements bac à sable et préproduction.

Request

Code Samples

Headers

x-fapi-financial-id required

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

x-bmo-id-token

string

Body

Response

Table JSON

SECURE { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}