V 1.3.7 - e-Financing API

Version 1.3.7 - depreciated

Change log:

• Add a new endpoint /susbcriptions/{creditSubscriptionId}/_confirmDelivery

Eligibility

retrieve eligible E-financing solutions

get

retrieve eligible E-financing solutions given financed amount and buyer country. As a result, you will a list of E-financing solutions codes with their related merchant kits. A merchant kit will allow you to display E-financing visual name, label, description , logo and product terms to the customer. An empty json object is returned if not eligible.

Authorizations

Query parameters

buyerBillingCountrystringRequired

FR for France or DE for Germany. ISO 3166-1 alpha-2

Example: FR

financedAmountnumber · floatRequired

amount to be financed

Example: 999.99

Responses

get

HTTPcURLJavaScriptPython

GET /baas/prod/e-financing/api/v1/eligible-solutions HTTP/1.1
Host: api.scalexpert.societegenerale.com
Accept: */*

{
  "solutions": [
    {
      "solutionCode": "SCFR3XY",
      "familyCode": "SC",
      "marketCode": "FR for France or DE for Germany",
      "conditions": "xxx",
      "communicationKit": {
        "solutionCode": "SCSPFR",
        "visualTitle": "Payez en 3 ou 4 fois",
        "visualInformationIcon": "XXX/XXX.ico (url icon)",
        "visualAdditionalInformation": "xxx",
        "visualLegalText": "xxx",
        "visualTableImage": "https://merchant.kit/uri/table.png",
        "visualLogo": "https://merchant.kit/uri/productTerms.ico",
        "visualInformationNoticeURL": "https://merchant.kit/uri/productTerms.pdf",
        "visualProductTermsURL": "https://merchant.kit/uri/productTerms.pdf"
      }
    }
  ]
}

Subscriptions

Initiate a E-Financing subscription at the E-Financing producer side

post

To initiate a E-Financing subscription you will have to complete the requested parameters from the context of your checkout page of which identity, address of the buyer, amount to be financed, E-Financing payment choosen (product code), basket items details ... You can refer your E-Financing susbsription with your order or basket id. As a result you will get a E-Financing subscription Id and a redirect URL or HMTL page to E-Financing customer journey managed at the producer side

Important: the "solutionCode" is the parameter that determine the Producer's solution such as split payment or smart credit choosen by the buyer in the checkout page

Authorizations

Body

Credit Subscription Request

solutionCodestringRequired

ID of the BaaS product used

Example: SCDELTPattern: ^\w{6}-\w{4}$|^\w{6}$

merchantBasketIdstringRequired

ID of the basket of the current transaction, as given by the merchant (third party)

Example: 647aeb24-a89c-11ed-afa1-0242ac120002

merchantGlobalOrderIdstringRequired

ID of the order as a whole - as long as the items are not dispatched separately, with different order IDs (cf. basket table)

Example: 3e46d670-aca7-11ed-afa1-0242ac120002

merchantBuyerIdstringRequired

ID of the buyer (final customer), as given by the merchant (third party)

Example: 44226c6c-aca7-11ed-afa1-0242ac120002

financedAmountnumber · floatRequired

Total amount within the basket which is financed by credit - can represent the whole basket if every item is financed

Example: 119.9

Responses

post

HTTPcURLJavaScriptPython

POST /baas/prod/e-financing/api/v1/subscriptions HTTP/1.1
Host: api.scalexpert.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 2364

{
  "solutionCode": "SCDELT",
  "merchantBasketId": "647aeb24-a89c-11ed-afa1-0242ac120002",
  "merchantGlobalOrderId": "3e46d670-aca7-11ed-afa1-0242ac120002",
  "merchantBuyerId": "44226c6c-aca7-11ed-afa1-0242ac120002",
  "financedAmount": 119.9,
  "merchantUrls": {
    "confirmation": "https://mymerchand.domain/uri"
  },
  "buyers": [
    {
      "birthName": "Dupont",
      "birthDate": "text",
      "birthCityName": "Montpellier",
      "birthCountryName": "FR",
      "deliveryMethod": "Click & Collect",
      "lastDatePurchase": "text",
      "vip": false,
      "contact": {
        "lastName": "Dupont",
        "firstName": "Paul",
        "commonTitle": "MR",
        "email": "[e-mail]",
        "mobilePhoneNumber": "[phone]",
        "phoneNumber": "[phone]",
        "professionalTitle": "Professor"
      },
      "contactAddress": {
        "locationType": "BILLING_ADDRESS",
        "streetNumber": 147,
        "streetNumberSuffix": "B",
        "streetName": "main street",
        "streetNameComplement": "block 47",
        "zipCode": "92060",
        "cityName": "Paris",
        "regionName": "Île-de-France",
        "countryCode": "FR"
      },
      "billingContact": {
        "lastName": "Dupont",
        "firstName": "Paul",
        "commonTitle": "MR",
        "email": "[e-mail]",
        "mobilePhoneNumber": "[phone]",
        "phoneNumber": "[phone]",
        "professionalTitle": "Professor"
      },
      "billingAddress": {
        "locationType": "BILLING_ADDRESS",
        "streetNumber": 147,
        "streetNumberSuffix": "B",
        "streetName": "main street",
        "streetNameComplement": "block 47",
        "zipCode": "92060",
        "cityName": "Paris",
        "regionName": "Île-de-France",
        "countryCode": "FR"
      },
      "deliveryContact": {
        "lastName": "Dupont",
        "firstName": "Paul",
        "commonTitle": "MR",
        "email": "[e-mail]",
        "mobilePhoneNumber": "[phone]",
        "phoneNumber": "[phone]",
        "professionalTitle": "Professor"
      },
      "deliveryAddress": {
        "locationType": "BILLING_ADDRESS",
        "streetNumber": 147,
        "streetNumberSuffix": "B",
        "streetName": "main street",
        "streetNameComplement": "block 47",
        "zipCode": "92060",
        "cityName": "Paris",
        "regionName": "Île-de-France",
        "countryCode": "FR"
      }
    }
  ],
  "basketDetails": {
    "basketItems": [
      {
        "id": "M12345785513211",
        "quantity": 1,
        "model": "5KPM5",
        "label": "ROBOT PÂTISSIER À BOL RELEVABLE 4,8L - HEAVY DUTY 5KPM5",
        "price": 1199.99,
        "currencyCode": "EUR",
        "orderId": "OD456742",
        "brandName": "KitchenAid",
        "description": "Le robot pâtissier à bol relevable très résistant idéal pour mixer de grandes quantités d'ingrédients, équipé d'un bol en acier inoxydable amovible.",
        "specifications": "Puissance (W) 315, Tension (V) 220-240, Fréquence (Hz) 50/60",
        "category": "Small appliance",
        "sku": "ZG011AQA",
        "isFinanced": true
      }
    ]
  }
}

{
  "id": "1b8cb15b-fbd3-4a65-9a39-ab81f6307b81",
  "redirect": {
    "type": "url",
    "value": "text"
  }
}

Retrieve a list of E-Financing subscriptions

get

You can list all your subscriptions by specifying a reference such as an order id or a basket id. the response will contain subscription Id, dates, times, status, your references, amount financed ... Main use case: Use this API to retrieve status a credit subscription by refering an order Id or a basket Id. Important: The list is paginated

Authorizations

Query parameters

merchantGlobalOrderIdstringOptional

ID of the order as a whole - as long as the items are not dispatched separately, with different orders ID.

Example: 340005489

merchantBasketIdstringOptional

ID of the basket of the current transaction, as given by the merchant (thirdparty)

Example: 185462145

pageinteger · int32Optional

The page number

Default: 1Example: 1

pageSizeinteger · int32Optional

The number of elements per page

Default: 20Example: 20

Responses

get

HTTPcURLJavaScriptPython

GET /baas/prod/e-financing/api/v1/subscriptions HTTP/1.1
Host: api.scalexpert.societegenerale.com
Accept: */*

{
  "totalItemCount": 1,
  "subscriptions": [
    {
      "creditSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
      "registrationTimestamp": "2025-04-28T01:18:07.304Z",
      "lastUpdateTimestamp": "2025-04-28T01:18:07.304Z",
      "solutionCode": "SCDELT",
      "marketTypeCode": "FR",
      "implementationCode": "3X",
      "merchantBasketId": "061be358-acb1-11ed-afa1-0242ac120002",
      "merchantGlobalOrderId": "0c34ab62-acb1-11ed-afa1-0242ac120002",
      "buyerFinancedAmount": 1199.99,
      "consolidatedStatus": "INITIALIZED"
    }
  ]
}

Retrieve a specific E-Financing subscription

get

You can use this API to get all details of a E-Financing subscription. You will have to provide a E-Financing subscription Id previously obtained as listed or initiated.

Authorizations

Path parameters

creditSubscriptionIdstring · uuidRequired

The unique Credit Subscription Id

Responses

get

HTTPcURLJavaScriptPython

GET /baas/prod/e-financing/api/v1/subscriptions/{creditSubscriptionId} HTTP/1.1
Host: api.scalexpert.societegenerale.com
Accept: */*

{
  "creditSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
  "registrationTimestamp": "2025-04-28T01:18:07.304Z",
  "lastUpdateTimestamp": "2025-04-28T01:18:07.304Z",
  "clientId": "44f5060e-a89c-11ed-afa1-0242ac120002",
  "merchantId": "647aeb24-a89c-11ed-afa1-0242ac120002",
  "solutionCode": "SCDELT",
  "familyCode": "SC",
  "marketTypeCode": "FR",
  "implementationCode": "3X",
  "merchantBasketId": "647aeb24-a89c-11ed-afa1-0242ac120002",
  "merchantGlobalOrderId": "3e46d670-aca7-11ed-afa1-0242ac120002",
  "merchantBuyerId": "44226c6c-aca7-11ed-afa1-0242ac120002",
  "financedAmount": 119.9,
  "consolidatedStatus": "INITIALIZED",
  "buyer": {
    "birthName": "Dupont",
    "birthDate": "text",
    "birthCityName": "Montpellier",
    "birthCountryName": "FR",
    "deliveryMethod": "Click & Collect",
    "lastDatePurchase": "text",
    "vip": false,
    "contact": {
      "lastName": "Dupont",
      "firstName": "Paul",
      "commonTitle": "MR",
      "email": "[e-mail]",
      "mobilePhoneNumber": "[phone]",
      "phoneNumber": "[phone]",
      "professionalTitle": "Professor"
    },
    "contactAddress": {
      "locationType": "BILLING_ADDRESS",
      "streetNumber": 147,
      "streetNumberSuffix": "B",
      "streetName": "main street",
      "streetNameComplement": "block 47",
      "zipCode": "92060",
      "cityName": "Paris",
      "regionName": "Île-de-France",
      "countryCode": "FR"
    },
    "billingContact": {
      "lastName": "Dupont",
      "firstName": "Paul",
      "commonTitle": "MR",
      "email": "[e-mail]",
      "mobilePhoneNumber": "[phone]",
      "phoneNumber": "[phone]",
      "professionalTitle": "Professor"
    },
    "billingAddress": {
      "locationType": "BILLING_ADDRESS",
      "streetNumber": 147,
      "streetNumberSuffix": "B",
      "streetName": "main street",
      "streetNameComplement": "block 47",
      "zipCode": "92060",
      "cityName": "Paris",
      "regionName": "Île-de-France",
      "countryCode": "FR"
    },
    "deliveryContact": {
      "lastName": "Dupont",
      "firstName": "Paul",
      "commonTitle": "MR",
      "email": "[e-mail]",
      "mobilePhoneNumber": "[phone]",
      "phoneNumber": "[phone]",
      "professionalTitle": "Professor"
    },
    "deliveryAddress": {
      "locationType": "BILLING_ADDRESS",
      "streetNumber": 147,
      "streetNumberSuffix": "B",
      "streetName": "main street",
      "streetNameComplement": "block 47",
      "zipCode": "92060",
      "cityName": "Paris",
      "regionName": "Île-de-France",
      "countryCode": "FR"
    }
  },
  "basketDetails": "FR"
}

Delivery

Confirm delivery of the items related to a specific creditSusbscriptionId

post

Confirm delivery of the items related to a specific creditSusbscriptionId. Needed for long term credits only

Authorizations

Path parameters

creditSubscriptionIdstringRequired

Body

isDeliveredbooleanRequired

Refers to the request to use to confirm the delivery of the items

Example: true

trackingNumberstring · min: 1 · max: 100Optional

The delivery identifier

Example: 12349875641919191000

operatorstring · enumOptional

The delivery company

Example: DHLPossible values:

Responses

Responseobject

post

HTTPcURLJavaScriptPython

POST /baas/prod/e-financing/api/v1/subscriptions/{creditSubscriptionId}/_confirmDelivery HTTP/1.1
Host: api.scalexpert.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "isDelivered": true,
  "trackingNumber": "12349875641919191000",
  "operator": "DHL"
}

{}

Cancellations

Request for a cancellation for a specific E-Financing subscription

post

Request for a cancellation request for a specific E-Financing subscription. Your request is different according the subscription kind (solution code)

Authorizations

Path parameters

creditSubscriptionIdstring · uuidRequired

The unique Credit Subscription Id

Body

cancelledAmountnumberOptional

cancelledItemstringOptional

cancellationReasonstringOptional

Responses

post

HTTPcURLJavaScriptPython

POST /baas/prod/e-financing/api/v1/subscriptions/{creditSubscriptionId}/_cancel HTTP/1.1
Host: api.scalexpert.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "cancelledAmount": 1,
  "cancelledItem": "text",
  "cancellationReason": "text",
  "cancellationContact": {
    "lastName": "Dupont",
    "firstName": "Paul",
    "email": "[e-mail]",
    "phoneNumber": "09 55 55 66 66"
  }
}

{
  "financedAmount": 119.9,
  "status": "ACCEPTED"
}

Download OpenAPI specs:

38KB

swagger_e-financing_1.3.7.yaml