create_refund_link


POST  -- Créer un lien de remboursement pour un payment

Argument Description Type - Taille Exemple Obligatoire
reference Référence du remboursement String - 32 OUI
shop_reference Référence de la campagne String - 32 OUI
campaign_reference Référence de la campagne String - 32 NON
safedebit_consumer_reference Référence Safedebit du consommateur String - 35 NON ***
last_name Nom du consommateur String - 64 NON
first_name Prénom du consommateur String - 64 NON
mail Email du consommateur String - 64 OUI *
phone_number Téléphone du consommateur String - 64 OUI *
amount Le montant (en centimes) String - 11 OUI
motif Motif du prélèvement String - 64 NON
street_number Numéro de rue String - 5 NON
street_name Nom de rue String - 64 NON
postal_code Code postal String - 5 NON
city Ville String - 64 NON
country Pays String - 64 NON
sms_template Texte reçu par le consommateur par SMS String - 64 OUI **
email_template Texte reçu par le consommateur par mail String - 64 OUI **
send_by_email Texte reçu par le consommateur par mail Integer - 1 Option d'envoi du lien de remboursement par email (1 : oui, 0 : non)
 OUI *
send_by_sms Texte reçu par le consommateur par mail Integer - 1 Option d'envoi du lien de remboursement par sms (1 : oui, 0 : non)
 OUI *

Requête

POST /xxxx/create_refund_link HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json 

                                                
                                                    {
"reference": "TEST-1",
"shop_reference": "SHOP-123",
"campaign_reference": "CAMPAING-1",
"last_name": "Foo",
"first_name": "Bar",
"mail": "foo.bar@mail.com",
"phone_number": "0600000000",
"amount": "1000",
"motif": "Remboursement",
"street_number": "25",
"street_name": "Rue Louis Legrand",
"postal_code": "75002",
"city": "Paris",
"country": "FR",
"sms_template": "Hello, this is the link : ",
"email_template": "Bonjour, voici le lien : "}
Si les paramètres envoyés sont valides

Réponse

HTTP/1.1 200 OK
Content-Type: application/json 

                                             
                                                {
                                                    "result": false,
                                                    "link": "https://xxxxxxxx.fr/xxxxx",
                                                    "safedebit_consumer_reference": "xxxxxx"
                                                }
Si les paramètres envoyés sont erronés

Réponse

HTTP/1.1 400
Content-Type: application/json 

                                            
                                                {
                                                    "result": false,
                                                    "errors": {
                                                        "reference": "Un paiement de remboursement avec la référence TEST-1 existe déjà.",
                                                        "amount": "Le champ amount est manquant dans le tableau de données."
                                                    }
                                                }