recherche_paiement


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

Argument Description Type - Taille Exemple Obligatoire
reference_paiement Référence de la transaction du virement ou du prélèvement String - 35 OUI
statut_paiement Paiement statut String - 2 OUI
date_rejet Date de rejet String - 10 OUI
liste_reference_paiement Liste de références de virements ou de prélèvements JSON NON
reference_regie Référence unique de la régie de l’établissement de santé String - 32 NON
safedebit_reference_patient Référence Safedebit du patient (référence unique par patient générée par SSP et retournée à l’éditeur suite à la création du mandat) String - 35 NON
liste_reference_paiement 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
reference_etablissement La référence de l'établissement de santé String - 32 NON
rum Identifiant unique du mandat String - 35 NON
montant Montant du prélèvement en centimes String - 18 NON
montant_min Montant min du prélèvement en centimes String - 18 NON
montant_max Montant max du prélèvement en centimes String - 18 NON
date_creation 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
date_validation Date de validation String - 10 NON
date_validation_min Date de validation minimum String - 10 NON
date_validation_max Date de validation maximum String - 10 NON
sdd_numero Nombre des prélèvements String - 3 NON
date_rejet_min Date de rejet minimum String - 10 NON
date_rejet_max Date de rejet maximum String - 10 NON


Requête

GET /xxxx/recherche_paiement?reference_paiement=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": [
        {
            "reference_paiement": "123456789",
            "reference_etablissement": null,
            "reference_regie": null,
            "rum": "SSP-XXXXXXXXXXXXXX",
            "safedebit_reference_patient": "2536987415263",
            "safedebit_reference_garantie": "SF_XXXXX",
            "montant": "XXXX",
            "date_creation": "2020-11-20 XX:XX:XX",
            "date_validation": null,
            "statut_paiement": "3",
            "paiement_methode": "SAFEDEBIT",
            "sdd_numero": "1",
            "echances": [
                {
                    "reference_sdd": "SSPXXXXXX",
                    "montant": "XXXXXX",
                    "date_sdd": "23/11/2020",
                    "safedebit_reference_garantie": "SF_XXXXXX",
                    "sdd_statut": "WAITING",
                    "motif_rejet": null,
                    "date_rejet": null,
                    "reference_paiement": "123456789",
                    "safedebit_reference_patient": "2536987415263",
                    "reference_regie": 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
reference_paiement Référence du virement
reference_etablissement Référence unique de l'établissement de santé
reference_regie Référence unique de la régie de l’établissement de santé
rum Identifiant unique du mandat
safedebit_reference_patient Référence Safedebit du patient
safedebit_reference_garantie Référence Safedebit de garantie
montant Montant du virement
date_creation Date de creation
transfer_date Date du virement
date_validation Date de validation
statut_paiement Paiement statut
paiement_methode « SAFEDEBIT » ou « CB »
sdd_numero Nombre des prélèvements
Échéances Tableau Json des enregistrements répondant aux arguments de recherche
reference_sdd Référence du prélèvement
montant Montant du prélèvement en centimes
date_sdd Date de prélèvement
safedebit_reference_garantie Référence Safedebit de garantie
sdd_statut Statut du prélèvement
motif_rejet Raison du rejet
date_rejet Date de rejet
reference_paiement Référence du paiement
safedebit_reference_patient Référence Safedebit du patient
reference_regie Référence unique de la régie de l’établissement de santé
code Voir codes d'erreur en annexe.
Merci de remplir tous les champs obligatoires
Requête

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