upload_file
POST - Ajout d'un fichier
Dans le cadre du contrat liant le commerçant au garantisseur, pour construire le faisceau de preuve, l'ajout de pièces justificatives peut être obligatoire.
L'action upload_file permet de transmettre ces pièces. Cette transmission doit être réalisée avant create_mandate dans le cas où ces fichiers ont été rendus obligatoires par le paramétrage du marchand.
Dans le cadre de l’utilisation de cette action, un traitement de vérification des pièces qui composent ce faisceau de preuves peut avoir lieu. Cette vérification peut entraîner un rejet du fichier. Ce processus de contrôle est piloté par le « Mode de Vérification », qui permet entre autres de forcer l’upload du fichier dans le cas où le document ne serait pas lisible.
Lors de la création d'un mandat, l'ensemble des pièces sont automatiquement associées au mandat. Si le mandat est déjà présent, les pièces sont directement associées au mandat. Dans le cas de la renouvellement d'un mandat, les pièces doivent être envoyées à nouveau.
| Argument | Description | Type - Taille | Exemple | Obligatoire |
|---|---|---|---|---|
| safedebit_consumer_reference | Référence Safedebit du consommateur | String - 35 | OUI | |
| file_data * | Fichier encodé en base64 | String | base64Binary | OUI |
| file_type * | Type du fichier | Char - 1 | 1: mandat 2 : Identité 3 : IBAN 4 : KBIS 5 : Autres | OUI |
| file_description ** | Description du fichier | String - 256 | NON | |
| file_verif | Mode de Vérification | String - 256 | 1 : Echec : Pas d'upload en cas d'échec du contrôle 2 : Echec Lecture : L'upload continue sauf dans le cas d'une lecture négative. Le résultat du contrôle est transféré dans le paramètre verif. Le comportement par défaut dépend du paramétrage marchand (1 si le service est disponible, aucun contrôle si le service est indisponible). | NON |
* Les extensions autorisées : gif,jpeg,jpg,png,pdf.
** Caractères alphanumériques seulement. Peut être utilisé pour donner plus de détails sur le type de fichier (exemple : CNI recto, verso...)Kbis ( résultat de la vérification )
| Argument | Description | Type |
|---|---|---|
| readable | Fichier lu | true ou false |
| valid | KBis verifié comme valide auprès d'infogreffe | true ou false |
| expired | KBis expiré (plus de 3 mois) | true ou false |
| social_reference | Raison sociale correcte | true ou false |
| siren | SIREN correct | true ou false |
Requête
POST /xxxx/upload_file HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"safedebit_consumer_reference": "XXXXXX",
"file_type": "2",
"file_data": "XjljSHJKhbJSHjkS...........",
"file_description": "CNI"}
Réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"file_key" : "xxxxxx"
}
Si l’ajout du fichier 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 |
| file_key | Une clé unique pour chaque fichier à utiliser pour la récupération de ce dernier |
| code | Voir codes d'erreur en annexe. |
| verif | Tableau Json des détails du résultat de la vérification Uniquement présent si la vérification a eu lieu |
Requête
HTTP/1.1 200 OK
POST /ssp/upload_file HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json