get_refund_links


GET  -- Get refund links according to the parameters

Argument Description Type - Length Example Mandatory
reference Refund reference String - 32 NO
campaign_reference Campaign reference String - 32 NO
amount Campaign reference String - 11 NO
mail Campaign reference String - 64 NO
phone_number Campaign reference String - 12 NO
safedebit_consumer_reference safedebit_consumer_reference.label is missing String - 35 NO
link_creation_date_min Min Creation date link date NO
link_creation_date_max Max Creation date link date NO

Request

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

                                                
                                                    {
"campaign_reference": "CAMPAING-2",
"reference": "link_ref",
"amount": "180",
"mail": "xxx@xx.xx",
"phone_number": "xxxxxxxxxx",
"safedebit_consumer_reference": "xxxxxxxxxxx",
"link_creation_date_min": "xxxxxxxxxxx",
"link_creation_date_max": "xxxxxxxxxxx"}
If parameters sent are valid

Response

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


                                                {
                                                "result": true,
                                                "links": [
                                                    {
                                                        "campaign_reference": "CAMPAING-2",
                                                        "reference": "TEST-4",
                                                        "link": "https://sspay.fr/XXXXXX",
                                                        "amount": 100,
                                                        "creation_date" : "YYYY-MM-DD HH:II:SS"
                                                    },
                                                    {
                                                        "campaign_reference": "CAMPAING-2",
                                                        "reference": "TEST-5",
                                                        "link": "https://sspay.fr/XXXXXX",
                                                        "amount": 200,
                                                        "creation_date" : "YYYY-MM-DD HH:II:SS"
                                                    },
                                                    {
                                                        "campaign_reference": "CAMPAING-2",
                                                        "reference": "TEST-6",
                                                        "link": "https://sspay.fr/XXXXXX",
                                                        "amount": 300,
                                                        "creation_date" : "YYYY-MM-DD HH:II:SS"
                                                    },
                                                    {
                                                        "campaign_reference": "CAMPAING-2",
                                                        "reference": "TEST-7",
                                                        "link": "https://sspay.fr/XXXXXX",
                                                        "amount": 400,
                                                        "creation_date" : "YYYY-MM-DD HH:II:SS"
                                                    },
                                                    {
                                                        "campaign_reference": "CAMPAING-2",
                                                        "reference": "TEST-8",
                                                        "link": "https://sspay.fr/XXXXXX",
                                                        "amount": 600,
                                                        "creation_date" : "YYYY-MM-DD HH:II:SS"
                                                    }
                                                ]
                                            }
If erroneous parameters are sent

Response

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

                                            
                                            {
                                                "result": false,
                                                "error": {
                                                    "amount": "Le champ amount n'a pas le bon format."
                                                }
                                            }