V 1.7.1 - e-Financing API

Version 1.7.1 - latest

Download OpenApi specs (YAML)

Description

The E-financement API is used to initiate and manage a E-financement subscription from the checkout page on behalf of the buyer.

You will obtain a redirect Url or a Html page to the producer E-financement customer journey.

At any time you can retrieve the status and details of your E-financement subscriptions.

Once your subscription request is accepted by financing institution, you can request for a full or partial cancellation request. According, your subscription kind (solution code) you would have to notify the financing institution of, first the delivery of goods, and second the return of delivery before any cancellation request.

Change log 1.7.1:

• Add validations about max length and format of the fields of the request body of the POST /subscriptions: Buyers and the sub-resources contact and address.

• Update phone number, mail address pattern with formats that match the corresponding ISO.

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

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/e-financing/api/v1/eligible-solutions?buyerBillingCountry=FR&financedAmount=999.99'

200

401

403

default

200

{
  "solutions": [
    {
      "solutionCode": "SCFRSP-3XTS",
      "familyCode": "SC",
      "marketCode": "FR for France or DE for Germany",
      "conditions": "PS",
      "communicationKit": {
        "solutionCode": "SCFRSP-3XTS",
        "visualTitle": "Payez en 3 ou 4 fois",
        "visualDescription": "Baas is great",
        "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"
      }
    }
  ]
}

The financed amount and country is eligible

Simulations

Calculate the simulation of the eligible e-financing solutions

post

• Calculate the simulation of the eligible e-financing solutions
• If solutionCodes are not specified in the request, all eligible e-financing solutions will be simulated.
• The response returns an empty solutionSimulations array if there is no eligible e-financing solution or all the rquested solutions are not eligible.

Authorizations

Body

financedAmountnumber · floatrequired

• Amount to be financed is in the main unit of the EUR currency.
• financedAmount's value must be positive.
• The value MUST have at most 2 digits in the fractional part.

Example: 3943.36

buyerBillingCountrystring · enumrequired

Country of the buyer (FR for France or DE for Germany).

Example: FR

Available options:

solutionCodesstring[] · max: 100optional

List of codes used for identifying all or part of the eligible e-financing solutions to be simulated. By default, all eligible e-financing solutions will be simulated.

Example: List [ "SCFRSP-3XTS" ]

Responses

application/json

*/*

*/*

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/e-financing/api/v1/_simulate-solutions' \
  --header 'Content-Type: application/json' \
  --data '{
    "financedAmount": "1500.0",
    "buyerBillingCountry": "FR",
    "solutionCodes": [
      "SCFRSP-3XTS"
    ]
  }'

Simulation for the solution SCFRSP-3XTS.Simulation for the solution SCFRLT-TXNO.

200

400

401

403

default

200

Simulation for the solution SCFRSP-3XTS.

Simulation for the solution SCFRLT-TXNO.

Simulation for the solution SCFRSP-3XTS.

{
  "financedAmount": "1500.0",
  "buyerBillingCountry": "FR",
  "solutionSimulations": [
    {
      "solutionCode": "SCFRSP-3XTS",
      "simulations": {
        "duration": 3,
        "effectiveAnnualPercentageRate": 0,
        "nominalPercentageRate": 0,
        "totalCost": 0,
        "dueTotalAmount": "1500.0",
        "feesAmount": 0,
        "intallments": [
          {
            "number": 1,
            "amount": 500
          },
          {
            "number": 2,
            "amount": 500
          },
          {
            "number": 3,
            "amount": 500
          }
        ]
      }
    }
  ]
}

The result of the simulation of eligible financial solutions for a given amount and solution codes.

Example request and response:

Solution SCFRSP-3XTS

Request

{
    "buyerBillingCountry": "FR",
    "financedAmount": 1500.00,
     "solutionCodes": [
    "SCFRSP-4XTS"
  ]
}

Response

{

    "financedAmount": 1500.0,
    "buyerBillingCountry": "FR",
    "solutionSimulations": [
        {
            "solutionCode": "SCFRSP-4XTS",
            "simulations": [
                {
                    "duration": 4,
                    "effectiveAnnualPercentageRate": 0.0,
                    "nominalPercentageRate": 0.0,
                    "totalCost": 0.0,
                    "dueTotalAmount": 1500.0,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 375.0
                        },
                        {
                            "number": 2,
                            "amount": 375.0
                        },
                        {
                            "number": 3,
                            "amount": 375.0
                        },
                        {
                            "number": 4,
                            "amount": 375.0
                        }
                    ]
                }
            ]
        }
    ]
}

Solution SCFRLT-TXNO

Request

{
  "financedAmount": 5000,
  "buyerBillingCountry": "FR",
  "solutionCodes": [
    "SCFRLT-TXNO"
  ]
}

Response

{
    "financedAmount": 5000.0,
    "buyerBillingCountry": "FR",
    "solutionSimulations": [
        {
            "solutionCode": "SCFRLT-TXNO",
            "simulations": [
                {
                    "duration": 12,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 260.32,
                    "dueTotalAmount": 5260.32,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 438.36
                        }
                    ]
                },
                {
                    "duration": 24,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 508.24,
                    "dueTotalAmount": 5508.24,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 229.51
                        }
                    ]
                },
                {
                    "duration": 36,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 763.96,
                    "dueTotalAmount": 5763.96,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 160.11
                        }
                    ]
                },
                {
                    "duration": 48,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 1026.88,
                    "dueTotalAmount": 6026.88,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 125.56
                        }
                    ]
                }
            ]
        }
    ]
}

All solutions

Request

{
    "buyerBillingCountry": "FR",
    "financedAmount": 1500.00
}

Response

{
    "financedAmount": 1500.0,
    "buyerBillingCountry": "FR",
    "solutionSimulations": [
        {
            "solutionCode": "SCFRSP-4XTS",
            "simulations": [
                {
                    "duration": 4,
                    "effectiveAnnualPercentageRate": 0.0,
                    "nominalPercentageRate": 0.0,
                    "totalCost": 0.0,
                    "dueTotalAmount": 1500.0,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 375.0
                        },
                        {
                            "number": 2,
                            "amount": 375.0
                        },
                        {
                            "number": 3,
                            "amount": 375.0
                        },
                        {
                            "number": 4,
                            "amount": 375.0
                        }
                    ]
                }
            ]
        },
        {
            "solutionCode": "SCFRLT-TXPS",
            "simulations": [
                {
                    "duration": 6,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 41.7,
                    "dueTotalAmount": 1541.7,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 256.95
                        }
                    ]
                },
                {
                    "duration": 12,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 78.0,
                    "dueTotalAmount": 1578.0,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 131.5
                        }
                    ]
                },
                {
                    "duration": 18,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 114.96,
                    "dueTotalAmount": 1614.96,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 89.72
                        }
                    ]
                },
                {
                    "duration": 24,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 152.4,
                    "dueTotalAmount": 1652.4,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 68.85
                        }
                    ]
                }
            ]
        },
        {
            "solutionCode": "SCFRLT-TXNO",
            "simulations": [
                {
                    "duration": 6,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 41.7,
                    "dueTotalAmount": 1541.7,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 256.95
                        }
                    ]
                },
                {
                    "duration": 12,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 78.0,
                    "dueTotalAmount": 1578.0,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 131.5
                        }
                    ]
                },
                {
                    "duration": 18,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 114.96,
                    "dueTotalAmount": 1614.96,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 89.72
                        }
                    ]
                },
                {
                    "duration": 24,
                    "effectiveAnnualPercentageRate": 9.9,
                    "nominalPercentageRate": 9.477,
                    "totalCost": 152.4,
                    "dueTotalAmount": 1652.4,
                    "feesAmount": 0.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 68.85
                        }
                    ]
                }
            ]
        },
        {
            "solutionCode": "SCFRSP-4XPS",
            "simulations": [
                {
                    "duration": 4,
                    "effectiveAnnualPercentageRate": 12.584,
                    "nominalPercentageRate": 0.0,
                    "totalCost": 20.0,
                    "dueTotalAmount": 1520.0,
                    "feesAmount": 20.0,
                    "installments": [
                        {
                            "number": 1,
                            "amount": 395.0
                        },
                        {
                            "number": 2,
                            "amount": 375.0
                        },
                        {
                            "number": 3,
                            "amount": 375.0
                        },
                        {
                            "number": 4,
                            "amount": 375.0
                        }
                    ]
                }
            ]
        }
    ]
}

Subscriptions

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

post

To initiate an E-Financing subscription you will have to collect from your users (some will com from the checkout journey and other from your buyer's profile) the requested parameters including the following :

• identity,
• address of the buyer,
• amount to be financed,
• payment choosen (product code),
• basket items details
• ...

(You'll later be able to refer your E-Financing subsription with either your order id or basket id.)

Upon successful completion you will receive a json with :

• a subscription Id
• a redirect URL (managed by the lender) so your customer can proceed with its application journey

Important

In the request body the solutionCode is 1-to-1 mapped to the lenders and their offers. This means the two following information are key for you to choose the correct solutionCode :

• the buyer's financement type choosed on the checkout page
• the buyer's location : France or Germmany (more markets to come..)

The detail of solutions codes used are here : https://docs.scalexpert.societegenerale.com/apidocs/3mLlrPx3sPtekcQvEEUg/use-cases/credit#e-financing-solution-codes

Authorizations

Query parameters

languagestringrequired

Requested language of the UI to be used for the application journey on the lender website. de-DE for a HB credit subscriptions (with solution codes starts with SCDELT) and fr-FR for FF credit subscriptions (solution codes start with SCFR..).

Example: de-DE

Body

solutionCodestringrequired

ID of the BaaS product used

Example: SCFRSP-3XPS

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

merchantUrlsobjectrequired

buyersobject[] · min: 1 · max: 100required

List of buyers.

basketDetailsobjectrequired

Providing details about the products selected by the client in the basket from merchant portal such as main product,the total amount and quantity of the cart.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/e-financing/api/v1/subscriptions?language=de-DE' \
  --header 'Content-Type: application/json' \
  --data '{
    "solutionCode": "SCFRSP-3XPS",
    "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": "1975-02-01",
        "birthCityName": "Montpellier",
        "birthCountryName": "FR",
        "deliveryMethod": "Click & Collect",
        "lastDatePurchase": "2020-02-01",
        "vip": false,
        "contact": {
          "firstName": "Paul",
          "lastName": "Dupont",
          "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": {
          "firstName": "Paul",
          "lastName": "Dupont",
          "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": {
          "firstName": "Paul",
          "lastName": "Dupont",
          "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
        }
      ]
    }
  }'

201

401

403

default

201

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

Initiate an E-Financing subscription

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 · int32 · default: 1optional

The page number

Example: 1

pageSizeinteger · int32 · default: 20optional

The number of elements per page

Example: 20

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/e-financing/api/v1/subscriptions'

200

401

403

default

200

{
  "totalItemCount": 1,
  "subscriptions": [
    {
      "creditSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
      "registrationTimestamp": "2024-04-22T10:00:19.077Z",
      "lastUpdateTimestamp": "2024-04-22T10:00:19.077Z",
      "solutionCode": "SCFRSP-4XPS",
      "marketTypeCode": "FR",
      "implementationCode": "4X",
      "merchantBasketId": "061be358-acb1-11ed-afa1-0242ac120002",
      "merchantGlobalOrderId": "0c34ab62-acb1-11ed-afa1-0242ac120002",
      "buyerFinancedAmount": 1199.99,
      "consolidatedStatus": "ACCEPTED",
      "cancellationStatus": "REQUEST_FOR_PARTIAL_CANCELLATION",
      "cancellationAlreadyMade": false,
      "consolidatedSubstatus": "SUBSCRIPTION APPROVED BY PRODUCER",
      "isDelivered": true,
      "isReturned": true
    }
  ]
}

List of credit subscriptions

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 E-financement Subscription Id

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/e-financing/api/v1/subscriptions/{creditSubscriptionId}'

200

401

403

default

200

{
  "creditSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
  "registrationTimestamp": "2024-04-22T10:00:19.077Z",
  "lastUpdateTimestamp": "2024-04-22T10:00:19.077Z",
  "solutionCode": "SCFRSP-4XPS",
  "familyCode": "SC",
  "marketTypeCode": "FR",
  "implementationCode": "4X",
  "merchantBasketId": "647aeb24-a89c-11ed-afa1-0242ac120002",
  "merchantGlobalOrderId": "3e46d670-aca7-11ed-afa1-0242ac120002",
  "merchantBuyerId": "44226c6c-aca7-11ed-afa1-0242ac120002",
  "financedAmount": 119.9,
  "consolidatedStatus": "ACCEPTED",
  "cancellationStatus": "REQUEST_FOR_PARTIAL_CANCELLATION",
  "cancellationAlreadyMade": false,
  "buyer": {
    "birthName": "Dupont",
    "birthDate": "1975-02-01",
    "birthCityName": "Montpellier",
    "birthCountryName": "FR",
    "deliveryMethod": "Click & Collect",
    "lastDatePurchase": "2020-02-01",
    "vip": false,
    "contact": {
      "firstName": "Paul",
      "lastName": "Dupont",
      "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": {
      "firstName": "Paul",
      "lastName": "Dupont",
      "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": {
      "firstName": "Paul",
      "lastName": "Dupont",
      "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",
  "consolidatedSubstatus": "SUBSCRIPTION APPROVED BY PRODUCER",
  "isReturned": true,
  "isDelivered": true
}

Specific E-Financing subscription

Delivery

Confirm delivery of the items related to a specific creditSubscriptionId

post

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

Authorizations

Path parameters

creditSubscriptionIdstring · uuidrequired

The unique E-financement Subscription Id

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: DHL

Available options:

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/e-financing/api/v1/subscriptions/{creditSubscriptionId}/_confirmDelivery' \
  --header 'Content-Type: application/json' \
  --data '{
    "isDelivered": true,
    "trackingNumber": "12349875641919191000",
    "operator": "DHL"
  }'

204

401

403

default

204

{}

request accepted but not processed (short term credit)

Confirm that the customer has returned the delivered items to the merchant.

post

• Confirm that the customer has returned the delivered items to the merchant.
• This endpoint is only usefull for long-term credit.
• This request is a prerequisite of the cancel request.

Authorizations

Path parameters

creditSubscriptionIdstring · uuidrequired

The unique Credit Subscription Id

Body

isReturnedbooleanrequired

Items was returned or not from the customer to the merchant

Example: true

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/e-financing/api/v1/subscriptions/{creditSubscriptionId}/_confirmReturn' \
  --header 'Content-Type: application/json' \
  --data '{
    "isReturned": true
  }'

204

401

403

default

204

{}

Subscription is successfully updated.

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

cancelledAmountnumber · floatoptional

Amount cancelled asked. It will stored on the event table and deducted from the initial financed amount.

Example: 119.9

cancelledItemstringoptional

ID of a specific item within the basket

Example: M12345785513211

cancellationReasonstringoptional

The reason why the credit is cancelled in the transacation

Example: The item is too big for my kitchen

cancellationContactobjectoptional

Responses

application/json

*/*

*/*

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/e-financing/api/v1/subscriptions/{creditSubscriptionId}/_cancel' \
  --header 'Content-Type: application/json' \
  --data '{
    "cancelledAmount": 110,
    "cancelledItem": "FOOBAR"
  }'

Cancellation Request for SCFRSPCancellation Request for SCFRLTCancellation Request for SCDELT

200

400

401

403

404

default

200

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

Credit cancellation confirmation response

Download OpenAPI specs:

60KB

swagger_e-financing_1.7.1-UATC.yaml

YAML UATC file

60KB

swagger_e-financing_1.7.1-PROD.yaml

YAML production file