Créer une caution

Créer une caution pour un client ou une agence d'un client.

  

➤ Cas d'usage

Ce service permet d'effectuer une demande de caution de marché à la CEGC. 

La réponse contient l'ensemble des éléments demandés pour la caution ainsi qu'un lien pour télécharger le document généré par la CEGC.
Le lien à récupérer est : marketBond.characteristics.marketBondDownloadLink.href.

➤ Prérequis

Pour procéder à cette requête, il est nécessaire de remplir les prérequis d’éligibilité et d'avoir récupéré le jeton d'accès (voir la rubrique "Vue d'ensemble" > "Récupération d'un jeton").

➤ Exemple

Requête

POST /v1/marketBonds/marketBondInitiate

 

Résultat

Status code : 201

Description : Le code retour 201 signifie que la demande de caution est prise en compte et que le document relatif à cette caution est disponible pour téléchargement.

Body

{  "marketBond":

             {    "characteristics"{     

                      "marketBondContractId": "string",     

                      "siren": "string",     

                      "marketBondId": "string",     

                      "marketBondDownloadLink":  {       

                             "href": "string"     

                     },     

                      "bondDetail":  {       

                           "effectiveBondDate": "string",       

                           "bondDueDate": "string",       

                           "marketBondTextId": "string",       

                           "warrantType": "string",       

                           "bondAmount": {         

                                 "value": 0,         

                                 "currencyCode": "string"       

                       },       

                      "provisionnalReleaseDate": "string",        

                      "clientBondId": "string",       

                      "clientComment": "string",       

                      "clientBranchId": "string",       

                      "additionalOption": "string",       

                      "optionReference": "string"     

                   },     

                   "marketDetail": {       

                       "type": "string",       

                       "amount": {         

                            "value": 0,         

                           "currencyCode": "string"       

                       },       

                       "date": "string",       

                       "dueDate": "string",       

                       "workNature": "string",       

                       "reference": "string"     

                   },     

                  "recipientDetail": {       

                      "siren": "string",       

                      "companyName": "string",       

                      "nationality": "string",       

                      "rCSPlace": "string",       

                      "juridicCategory": "string",       

                      "shareCapital": "string",       

                      "postAddress": {          

                            "location": [           

                                  "string"         

                              ],         

                             "postalCode": "string",         

                             "countrylso2": "string"       

                       },        

                       "headOfficeTown": "string"     

                    },      "addressee": {       

                                   "legalSituation": "string",       

                                   "physicalAddressee": {         

                                        "nationality": "string",         

                                        "livingCountry": "string",         

                                        "name": "string",         

                                        "surname": "string",         

                                        "civility": "string",          

                                        "postAddress": {           

                                             "location": [             

                                                   "string"           

                                             ],           

                                             "postalCode": "string",           

                                             "countrylso2": "string"         

                                        }       

                                   },       

                                   "companyAddressee": {          

                                       "siren": "string",         

                                       "companyName": "string",         

                                       "nationality": "string",         

                                       "postAddress": {           

                                            "location": [             

                                                "string"           

                                             ],            

                                             "postalCode": "string",           

                                             "countrylso2": "string"         

                                        },         

                                        "town": "string"       

                                    }     

                                }   

                            },   

                            "response": {     

                                "interactionId": "string",     

                                "code": "string",     

                                "label": "string"   

                             } 

                       }

                }

 

Status code : 400

Description : L'erreur 400 "Bad request" pourra être renvoyée dans le cas où la demande de caution ne respecte pas la définition.

Body

    {

      "errors": [

         {

        "code": "string",     

        "message": "string",     

        "attribute": "string",     

        "additionalInformation": "string"

          }

  ]

}

 

Status code : 500

Description : Internal Server Error.

Body

    {

      "errors": [

         {

        "code": "string",     

        "message": "string",     

        "attribute": "string",     

        "additionalInformation": "string"

          }

  ]

}

 

Status code : 503

Description : Internal Unavailable.

Body

    {

      "errors": [

         {

        "code": "string",     

        "message": "string",     

        "attribute": "string",     

        "additionalInformation": "string"

          }

  ]

}