search_payment


 GET    -- Récupérer les informations d'un paiement

Argument Description Type - Taille Exemple Obligatoire
payment_reference Référence du virement String - 35 NON
safedebit_secure_reference Référence Safedebit de garantie String - 10 NON
payment_status Paiement statut String - 2 NON
payment_method « SAFEDEBIT » ou « CB » String - 9 NON
reject_date Date de rejet String - 10 NON
payment_reference_list Liste de références de virements JSON NON
consumer_store Référence boutique Safedebit String - 32 NON
safedebit_consumer_reference Référence Safedebit du consommateur String - 35 NON
payment_reference_list Liste de références de virements JSON NON
transaction_id Référence de la transaction String - 64 NON
basket_id Basket id String - 64 NON
beneficiary_reference La référence du bénéficiaire String - 32 NON
umr Identifiant unique du mandat String - 35 NON
amount Montant du prélèvement en centimes String - 18 NON
amount_min Montant min du prélèvement en centimes String - 18 NON
amount_max Montant max du prélèvement en centimes String - 18 NON
creation_date Date de creation String - 10 NON
creation_date_min Date de creation minimum String - 10 NON
creation_date_max Date de creation String - 10 NON
validation_date Date de validation String - 10 NON
validation_date_min Date de validation minimum String - 10 NON
validation_date_max Date de validation maximum String - 10 NON
echeance_number Nombre des prélèvements String - 3 NON
reject_date_min Date de rejet minimum String - 10 NON
reject_date_max Date de rejet maximum String - 10 NON


Requête

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

Si les données des virements ont été récupérées avec succès

Réponse

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"
        }
    ]
}
Si la récupération des données a échoué

Réponse

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


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

Argument Description
result true ou false :
true : action réalisée avec succès
false : action échouée
datas Tableau Json des enregistrements répondant aux arguments de recherche
payment_reference Référence du virement
beneficiary_reference Référence unique du bénéficiaire
consumer_store Référence boutique Safedebit
umr Identifiant unique du mandat
safedebit_consumer_reference Référence Safedebit du consommateur
safedebit_secure_reference Référence Safedebit de garantie
amount Montant du virement
creation_date Date de creation
transfer_date Date du virement
validation_date Date de validation
payment_status Paiement statut
payment_method « SAFEDEBIT » ou « CB »
echeance_number Nombre des prélèvements
Échéances Tableau Json des enregistrements répondant aux arguments de recherche
sdd_reference Référence du prélèvement
amount Montant du prélèvement en centimes
due_date Date de prélèvement
safedebit_secure_reference Référence Safedebit de garantie
sdd_status Statut du prélèvement
reject_reason Raison du rejet
reject_date Date de rejet
payment_reference Référence du paiement
safedebit_consumer_reference Référence Safedebit du consommateur
consumer_store Référence boutique Safedebit
code Voir codes d'erreur en annexe.
Merci de remplir tous les champs obligatoires
Requête

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