search_payment


 GET    -- Search information from a payment

Argument Description Type - Length Example Mandatory
payment_reference Transfer reference String - 35 NO
safedebit_secure_reference Safedebit guarantee reference String - 10 NO
payment_status Payment status String - 2 NO
payment_method « SAFEDEBIT » or « CB » String - 9 NO
reject_date Reject date String - 10 NO
payment_reference_list Payment reference list JSON NO
consumer_store Safedebit store reference String - 32 NO
safedebit_consumer_reference Safedebit consumer reference String - 35 NO
payment_reference_list Payment reference list JSON NO
transaction_id Transaction reference String - 64 NO
basket_id Basket id String - 64 NO
beneficiary_reference Beneficiary reference String - 32 NO
umr Unique mandate reference String - 35 NO
amount Levy amount in cents String - 18 NO
amount_min Min levy amount in cents String - 18 NO
amount_max Max levy amount in cents String - 18 NO
creation_date Creation date String - 10 NO
creation_date_min Creation date min String - 10 NO
creation_date_max Creation date max String - 10 NO
validation_date Validation date String - 10 NO
validation_date_min Validation date minimum String - 10 NO
validation_date_max Validation date maximum String - 10 NO
echeance_number Number of levy deadlines String - 3 NO
reject_date_min Maximum reject date String - 10 NO
reject_date_max Minimum reject date String - 10 NO


Request

GET /xxxx/search_payment?payment_reference=prestataire-2020-01-02-xxxx&creation_date_min=02%2F01%2F2020&creation_date_max=02%2F01%2F2021 HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json

If transfer data was successfully fetched

Response

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


{
    "result": true,
    "datas": [
        {
            "payment_reference": "123456789",
            "beneficiary_reference": null,
            "consumer_store": null,
            "umr": "SSP-XXXXXXXXXXXXXX",
            "safedebit_consumer_reference": "2536987415263",
            "safedebit_secure_reference": "SF_XXXXX",
            "amount": "XXXX",
            "creation_date": "2020-11-20 XX:XX:XX",
            "validation_date": null,
            "payment_status": "3",
            "payment_method": "SAFEDEBIT",
            "echeance_number": "1",
            "echances": [
                {
                    "sdd_reference": "SSPXXXXXX",
                    "amount": "XXXXXX",
                    "due_date": "23/11/2020",
                    "safedebit_secure_reference": "SF_XXXXXX",
                    "sdd_status": "WAITING",
                    "reject_reason": null,
                    "reject_date": null,
                    "payment_reference": "123456789",
                    "safedebit_consumer_reference": "2536987415263",
                    "consumer_store": null
                }
            ],
            "payment_status_label": "VALIDATED"
        }
    ]
}
If data fetching failed

Response

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


{
    "result": false,
    "code": "XXXX"
}

Argument Description
result true or false :
true : action succeeded
false : action failed
datas Json array of records responding to search arguments
payment_reference Transfer reference
beneficiary_reference Unique reference of beneficiary
consumer_store Safedebit store reference
umr Unique mandate reference
safedebit_consumer_reference Safedebit consumer reference
safedebit_secure_reference Safedebit guarantee reference
amount Transfer amount
creation_date Creation date
transfer_date Transfer date
validation_date Validation date
payment_status Payment status
payment_method « SAFEDEBIT » or « CB »
echeance_number Number of levy deadlines
Levys Json array of records responding to search arguments
sdd_reference SDD reference
amount Levy amount in cents
due_date Direct debit due date
safedebit_secure_reference Safedebit guarantee reference
sdd_status Levy status
reject_reason Reject reason
reject_date Reject date
payment_reference Payment reference
safedebit_consumer_reference Safedebit consumer reference
consumer_store Safedebit store reference
code See (error codes in annex).
Thanks to fill-in all the mandatory fields
Request

HTTP/1.1 200 OK
POST /xxxx/search_payment HTTP/1.1
Host: xxx.xxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json