Paiements instantanés

Notre interface API Paiements instantanés est le choix idéal pour les paiements en temps réel au Canada. Grâce au service Virement Interac, vous pouvez rapidement envoyer ou demander de l'argent, être sûr que les fonds seront disponibles immédiatement et suivre leur état en temps réel. Tout ce dont vous avez besoin, c'est l'adresse courriel ou le numéro de compte du destinataire.

Aperçu

Limites:	25 000 $/paiement 25 000 $/demande de fonds 1 paiement/appel 1 demande de fonds/appel Appels illimités
Pays :	Canada seulement CAD seulement
Vitesse :	Dépôts instantanés (numéros de compte et courriels avec Dépôt automatique) Jusqu'à 30 minutes (courriels sans Dépôt automatique)
Heures limites (jours ouvrables) :	Toujours disponible

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

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 Demander des fonds

Obtenir l'état du paiement

Vérifiez le dernier état de vos paiements envoyés (CAMT.005). Cet appel renvoie l'état actuel d'un paiement particulier (Pain.002). Veuillez consulter le tableau ci-dessous pour plus d'informations sur les états possibles qui peuvent être renvoyés.

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.

Post

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

À venir

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 { . . .}

}

Obtenir l'état de la demande de fonds

Vérifiez l'état actuel de vos demandes de fonds envoyées (CAMT.005). Cet appel renvoie l'état actuel d'une demande de fonds particulière (Pain.002). Veuillez consulter notre tableau ci-dessous pour plus d'informations sur les états possibles qui peuvent être renvoyés.

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.

Post

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

À venir

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 { . . .}

}

Envoyer des paiements Demander des fonds

Demander des fonds

Demandez rapidement de l'argent par courriel ou percevez des paiements dans votre propre application (Pain.013). Pour les demandes envoyées par courriel, vous pouvez choisir une date d'expiration personnalisée comprise entre 2 heures et 30 jours.

Cet appel renvoie une confirmation si votre fichier a passé nos validations (Pain.014). S'il n'y a pas de problème, nous transmettons la demande à Interac, qui l'envoie par courriel au destinataire. Aucune approbation n'est requise.

Remarque : Pour une intégration invisible en arrière-plan, vous pouvez supprimer les courriels Interac traditionnels et utiliser à la place l'URL de la passerelle renvoyée dans votre application. Cela permet à votre utilisateur d'effectuer le paiement sans quitter votre application. Vous devez tout de même transmettre l'adresse courriel de l'utilisateur, même si vous décidez de ne pas envoyer les courriels par Interac.

Post

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

À venir

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 { . . .}

}

Obtenir les options de paiement

Vérifiez quelle option de paiement est disponible pour l'adresse courriel ou le numéro de compte du destinataire (ACMT.023). Cette vérification doit être effectuée avant que vous puissiez envoyer un paiement.

La réponse confirmera si les dépôts en temps réel sont disponibles et inclura un numéro de référence nécessaire pour créer votre paiement (ACMT.024). Les numéros de référence expirent dans les 10 minutes.

Remarque : Si vous essayez d'envoyer un paiement à une adresse courriel enregistrée pour le Dépôt automatique, notre réponse comprendra également le nom commercial ou le nom légal enregistré du titulaire du compte. Cela permet de confirmer que vous payez la bonne personne ou la bonne entreprise.

Post

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

À venir

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 { . . .}

}

Envoyer un paiement

Créez votre paiement (Pain.001) avant l'expiration de votre numéro de référence du dernier appel. Pour les paiements envoyés à une adresse courriel sans Dépôt automatique, vous pouvez spécifier une période d'expiration personnalisée comprise entre 1 et 30 jours.

Cet appel renvoie une confirmation si votre fichier a passé nos validations (Pain.002). Si aucun problème n'est détecté, les paiements sont transmis à Interac pour traitement. Aucune approbation n'est requise.

Remarque : Les paiements sont traités immédiatement et ne peuvent pas être prévus pour une date ultérieure. Ils ne peuvent pas non plus être modifiés ou annulés une fois envoyés.

Post

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

À venir

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 { . . .}

}