Boleto Bancario
Boleto Bancario est un mode de paiement basé sur des bons utilisé au Brésil. Les clients peuvent payer les bons de différentes manières, notamment en espèces, en ligne et aux GAB.
L’API Paiements de Paysafe prend en charge Boleto Bancario via SafetyPay en tant qu’instrument de paiement pour les marchands de jeux en ligne et de cryptomonnaies au Brésil.
Fonctionnalités
Boleto Bancario :
- Permet d’accepter les paiements des clients non bancarisés.
Ne comporte aucun risque en matière de rétrofacturation.
Expire si le paiement n’est pas effectué à la date d’expiration du Boleto – si le Boleto n’est pas payé dans les délais impartis, il expire et la transaction est annulée.
L’un des modes de paiement les plus populaires au Brésil.
Exigences de configuration
Pour créer des comptes dans les environnements de bac à sable et de production :
- Envoyez vos renseignements à it_integrations@safetypay.com
Vous recevrez un accès à un portail où vous pourrez accéder aux clés suivantes :- Clé secrète du marchand
- Clé de signature du marchand
- Fournissez-nous ces renseignements pour créer votre clé API; vous utiliserez cette clé API dans vos appels à l’API.
Votre gestionnaire de compte vous guidera tout au long de ce processus.
Exigences en matière de certification
Vous devez suivre une procédure de certification pour pouvoir utiliser Safetypay Express comme mode de paiement.
L’équipe d’intégration de Paysafe vous communiquera les exigences de certification.
Types de transaction
Paysafe prend en charge les types de transactions suivants :
- Paiements : pour transférer de l’argent du compte bancaire d’un client vers votre compte marchand. Après un paiement réussi, vous créditez le portefeuille du client.
Montant minimum : pas de montant minimum
Montant maximum : 57 000 BRL
Devise de traitement : BRL
Devise de règlement : USD
Diagramme de flux des paiements
Scénarios habituels
Pour traiter une requête de paiement en utilisant Boleto Bancario comme mode de paiement :
Créez un Payment Handle avec les paramètres suivants :
transactionType : PAYMENT
paymentType : BOLETO_BANCARIORedirigez le client vers l’URL de redirection SafetyPay afin qu’il puisse générer un code de paiement.
L’état du Payment Handle passera à PAYABLE; vous serez notifié de ce changement d’état via les webhooks que vous aurez configurés.Utilisez le paymentHandleToken renvoyé dans la réponse pour traiter la requête de paiement.
Le paiement sera à l’état PROCESSING jusqu’à ce que le client ait effectué le paiement.
Vous recevrez une notification de paiement terminé via les webhooks lorsque le client aura effectué le paiement avec succès.
Si vous ne recevez pas de webhooks, vous pouvez effectuer un appel GET pour demander l’état de la transaction. Toutefois, nous vous recommandons d’éviter d’interroger constamment l’API.
Voir Webhooks et appels GET pour de plus amples renseignements.
Liens renvoyés
- Une fois que le client a été redirigé vers SafetyPay Express, vous recevrez un webhook de Payment Handle. Lorsque vous effectuez un appel /payments, vous obtiendrez un état de paiement soit en cours de traitement, soit terminé, soit échoué.
- Une fois que le client a terminé la transaction sur Safetypay Express, il est redirigé vers votre lien de renvoi. Vous pouvez vérifier l’état de la réponse /payments et rediriger le client vers la page appropriée en fonction de l’état du paiement :
| État d’un paiement | Description |
|---|---|
| PROCESSING | La transaction n’est pas terminée et est en cours. Cela ne signifie pas que la transaction a échoué. Vous recevrez un webhook COMPLETED ou FAILED pour cette transaction à un stade ultérieur quand vous pourrez mettre à jour l’état de la transaction de votre côté. |
| COMPLETED | Le client a terminé la transaction avec succès du côté de SafetyPay. |
| FAILED | Le paiement a expiré du côté de SafetyPay. |
API à utiliser
Exemple de code
Requête de Payment Handle
Requête de création d’un Payment Handle pour un paiement avec Boleto Bancario :
{
"amount": 500,
"currencyCode": "BRL",
"merchantRefNum": "eb3b3cbe-1386-4c38-b967-63a90249e946",
transactionType:"transactionType": "PAYMENT",
"paymentExpiryMinutes":15,
"accountId": "1002622940",
"paymentType": "BOLETO_BANCARIO",
"profile": {
"email": "brlspcash@gmail.com"
},
"returnLinks": [
{
"rel": "default",
"href": "http://www.amazon.ca"
}
]
}
Réponse du Payment Handle
Réponse à une requête de création de gestionnaire de paiement :
{
"id": "be8b6064-2bf2-4e4b-88e8-ed1b6a37e1fd",
"paymentType": "BOLETO_BANCARIO",
"paymentHandleToken": "PHxTXOEU9AAOErZc",
"merchantRefNum": "6708dd07-088d-4e63-a928-f2971ed07962",
"currencyCode": "BRL",
"txnTime": "2023-03-14T05:22:09Z",
"customerIp": "213.208.158.220",
"status": "INITIATED",
"links": [
{
"rel": "redirect_payment",
"href": "https://api.test.paysafe.com/alternatepayments/v1/redirect?accountId=1002622940&paymentHandleId=be8b6064-2bf2-4e4b-88e8-ed1b6a37e1fd&token=eyJhbGciOiJIUzI1NiJ9.eyJhY2QiOiIxMDAyNjIyOTQwIiwicHlkIjoiYmU4YjYwNjQtMmJmMi00ZTRiLTg4ZTgtZWQxYjZhMzdlMWZkIiwiZXhwIjoxNjc4NzczMTMwfQ.4dVPogQVZR62bhFCeNe5Gu-yRBiGxRKmkfUsgyrWU1k"
}
],
"liveMode": false,
"simulator": "EXTERNAL",
"usage": "SINGLE_USE",
"action": "REDIRECT",
"executionMode": "SYNCHRONOUS",
"amount": 500,
"timeToLiveSeconds": 898,
"gatewayResponse": {
"operationId": "0123073466306406",
"id": "8cf7e476-e5c8-4fa3-bb8e-c1048ae61f36",
"processor": "SAFETYPAY"
},
"returnLinks": [
{
"rel": "default",
"href": "http://www.amazon.ca"
}
],
transactionType:"transactionType": "PAYMENT",
"gatewayReconciliationId": "8cf7e476-e5c8-4fa3-bb8e-c1048ae61f36",
"updatedTime": "2023-03-14T05:22:10Z",
"statusTime": "2023-03-14T05:22:10Z",
"paymentExpiryMinutes":15,
"profile": {
"email": "brlspcash@gmail.com"
}
}
Requête de paiement
Requête de paiement Boleto Bancario utilisant le paymentHandleToken reçu dans la réponse du Payment Handle :
{
"merchantRefNum": "4e3147e3-2bc0-4b9c-a43c-acf8d8b0e121",
"amount": 500,
"currencyCode": "BRL",
"dupCheck": true,
"settleWithAuth": true,
"paymentHandleToken": "PHxTXOEU9AAOErZc"
}
Réponse pour paiement
Réponse à une requête de paiement Boleto Bancario :
{
"id": "7d6d80d3-c56d-4dad-bd9c-0b5f88ddb169",
"paymentType": "BOLETO_BANCARIO",
"paymentHandleToken": "PHxTXOEU9AAOErZc",
"merchantRefNum": "3a0a62ed-78d3-44ac-8596-d009e51e7f92",
"currencyCode": "BRL",
"settleWithAuth": true,
"dupCheck": true,
"txnTime": "2023-03-14T05:22:09Z",
"customerIp": "213.208.158.220",
"status": "PROCESSING",
"gatewayReconciliationId": "8cf7e476-e5c8-4fa3-bb8e-c1048ae61f36",
"amount": 500,
"availableToRefund": 0,
"consumerIp": "213.208.158.220",
"liveMode": false,
"simulator": "EXTERNAL",
"updatedTime": "2023-03-14T05:23:18Z",
"statusTime": "2023-03-14T05:23:18Z",
"gatewayResponse": {
"operationId": "0123073466306406",
"id": "8cf7e476-e5c8-4fa3-bb8e-c1048ae61f36",
"processor": "SAFETYPAY",
"status": "101"
},
"availableToSettle": 0,
"profile": {
"email": "brlspcash@gmail.com"
},
"settlements": {
"amount": 500,
"txnTime": "2023-03-14T05:22:09.000+0000",
"availableToRefund": 0,
"merchantRefNum": "3a0a62ed-78d3-44ac-8596-d009e51e7f92",
"id": "7d6d80d3-c56d-4dad-bd9c-0b5f88ddb169",
"status": "PROCESSING"
}
}
Instructions de test
| Pays | currencyCode | countryCode | Instructions |
|---|---|---|---|
| Brésil | BRL | BR | Sur la page SafetyPay Express :
|