Endpoints orders management

PreviousEndpoints sellers on boarding NextMarketplace services error codes

Last updated 1 month ago

Was this helpful?

Retrieve all orders

get

Retrieve the list of orders including products and transactions information for a specific merchant (marketplace).

Authorizations

Query parameters

pagestring · default: "1"optional

Page number, starting from 1.

Example: 1

pageSizestring · default: "10"optional

A limit on the number of objects to be returned. Limit can range between 1 and 100.

Example: 10

lastUpdateDatestringoptional

Date of the last update on the order. Using the ISO format in UTC YYYY-MM-DD (new transaction, new payout, other....)

Example: 2023-02-13

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/orders'

200

401

403

default

{
  "pageCount": 1,
  "orders": [
    {
      "orderId": 123456,
      "solutionCode": "MPFRGE-S1YP",
      "merchantGlobalOrderId": "1234-azerty-56789",
      "amount": 65.15,
      "currencyCode": "EUR",
      "orderType": "PURCHASE",
      "merchantBuyerId": "1234-azerty-56789",
      "registrationTimestamp": "2023-04-22T06:00:00.000Z",
      "lastUpdateTimestamp": "2023-04-22T06:00:00.000Z",
      "items": [
        {
          "gtin": "7512345678915",
          "label": "Tea cup",
          "quantity": 4,
          "price": 15.55,
          "currencyCode": "EUR",
          "amount": 64
        }
      ],
      "transactions": [
        {
          "transactionId": 123456789,
          "type": "PAYMENT",
          "executionDate": "2023-04-22T06:00:00.000Z",
          "amount": 64,
          "currencyCode": "EUR",
          "merchantTransactionId": "1234-azerty-56789",
          "paymentMethodName": "PAYXPERT_SG",
          "isPaid": true,
          "dueDate": "2017-07-21",
          "paidAmount": 65
        }
      ],
      "orderSplits": [
        {
          "splits": [
            {
              "sellerId": 123456789,
              "amount": 65,
              "amountType": "SELLER_PAYMENT",
              "fee": 65,
              "feeType": "MKTP_FEES",
              "currencyCode": "EUR",
              "model": "3P",
              "splitProducerFeeAmount": 65,
              "isCashed": true
            }
          ]
        }
      ],
      "payoutSellers": [
        {
          "payoutSellerId": 123456789,
          "merchantPayoutSellerId": "1234-azerty-56789",
          "reasonLabel": "payout for April 2023",
          "executionDate": "2023-04-22T06:00:00.000Z",
          "transfers": [
            {
              "merchantTransferId": "1234-azerty-56789",
              "payoutAmount": 65,
              "currencyCode": "EUR"
            }
          ],
          "payoutOrders": [
            {
              "payoutRequestedAmount": 65,
              "payoutEffectiveAmount": 20,
              "payoutResidualAmount": 0,
              "currencyCode": "EUR"
            }
          ],
          "payoutPayment": {
            "paymentStatus": "PENDING",
            "paymentAmount": 85,
            "currencyCode": "EUR"
          }
        }
      ]
    }
  ]
}

Delete a specific order

delete

Delete an order by orderId (technical identifier)

Authorizations

Path parameters

orderIdinteger · int32required

Unique technical identifier of the order

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/orders/{orderId}'

204

401

403

default

{}

The order has been deleted

Retrieve a specific transaction

get

Retrieve a transaction by transactionId (technical identifier)

Authorizations

Path parameters

transactionIdinteger · int32required

Unique technical identifier of the transaction

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/transactions/{transactionId}'

200

401

403

default

{
  "transactionId": 321,
  "solutionCode": "MPFRGE-S1YP",
  "merchantGlobalOrderId": "1234-azerty-56789",
  "merchantTransactionId": "1234-azerty-56789",
  "orderId": 123456789,
  "type": "PAYMENT",
  "executionDate": "2023-04-22T06:00:00.000Z",
  "amount": 65,
  "currencyCode": "EUR",
  "paymentMethodName": "PAYXPERT_SG",
  "isPaid": true,
  "dueDate": "2017-07-21",
  "paidAmount": 65
}

List of Transactions

Retrieve all transactions

get

Retrieve the list of transactions for a specific merchant (marketplace).

Authorizations

Query parameters

pagestring · default: "1"optional

Page number, starting from 1.

Example: 1

pageSizestring · default: "10"optional

A limit on the number of objects to be returned. Limit can range between 1 and 100.

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/transactions'

200

401

403

default

{
  "pageCount": 1,
  "transactions": [
    {
      "transactionId": 321,
      "solutionCode": "MPFRGE-S1YP",
      "merchantGlobalOrderId": "1234-azerty-56789",
      "merchantTransactionId": "1234-azerty-56789",
      "orderId": 123456789,
      "type": "PAYMENT",
      "executionDate": "2023-04-22T06:00:00.000Z",
      "amount": 65,
      "currencyCode": "EUR",
      "paymentMethodName": "PAYXPERT_SG",
      "isPaid": true,
      "dueDate": "2017-07-21",
      "paidAmount": 65
    }
  ]
}

List of Transactions

Delete a specific transaction

delete

Delete a transaction by transactionId (technical identifier)

Authorizations

Path parameters

transactionIdinteger · int32required

Unique technical identifier of the transaction

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/transactions/{transactionId}'

204

401

403

default

{}

The transaction has been deleted

Retrieve all Transfers

get

Retrieve the list of transfers created by a specific merchant (marketplace).

Authorizations

Query parameters

pagestring · default: "1"optional

Page number, starting from 1.

Example: 1

pageSizestring · default: "10"optional

A limit on the number of objects to be returned. Limit can range between 1 and 100.

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/transfers'

200

401

403

default

{
  "pageCount": 1,
  "transfers": [
    {
      "transferId": 123456789,
      "sellerId": 123456789,
      "merchantTransferId": "9887975454",
      "solutionCode": "MPFRGE-S1YP",
      "accountingEntry": "TRANSFER_TO_MARKETPLACE",
      "reasonCode": "SUBSCRIPTION",
      "reasonLabel": "payout for April 2023",
      "executionDate": "text",
      "amount": 65.15,
      "currencyCode": "EUR",
      "status": "PENDING"
    }
  ]
}

Retrieve a specific transfers

get

Retrieve a transfer by transferId (technical identifier)

Authorizations

Path parameters

transferIdinteger · int32required

Unique technical identifier of the transfer

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/transfers/{transferId}'

200

401

403

default

{
  "pageCount": 1,
  "transfers": [
    {
      "transferId": 123456789,
      "sellerId": 123456789,
      "merchantTransferId": "9887975454",
      "solutionCode": "MPFRGE-S1YP",
      "accountingEntry": "TRANSFER_TO_MARKETPLACE",
      "reasonCode": "SUBSCRIPTION",
      "reasonLabel": "payout for April 2023",
      "executionDate": "text",
      "amount": 65.15,
      "currencyCode": "EUR",
      "status": "PENDING"
    }
  ]
}

Delete a specific transfer

delete

Delete a transfer by transferId (technical identifier). Only transfer with PENDING status can be deleted

Authorizations

Path parameters

transferIdstringrequired

Unique technical identifier of the transfer

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/transfers/{transferId}'

204

401

403

default

{}

Retrieve all payoutMerchants

get

Retrieve the list of payoutMerchant for a specific merchant (marketplace).

Authorizations

Query parameters

pagestring · default: "1"optional

Page number, starting from 1.

Example: 1

pageSizestring · default: "10"optional

A limit on the number of objects to be returned. Limit can range between 1 and 100.

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/payout-merchants'

200

401

403

default

{
  "pageCount": 1,
  "payoutMerchants": [
    {
      "payoutMerchantId": 4,
      "merchantPayoutMerchantId": "1234-azerty-56789",
      "solutionCode": "MPFRGE-S1YP",
      "reasonLabel": "payout for April 2023",
      "executionDate": "2023-04-22T06:00:00.000Z",
      "amount": 65,
      "currencyCode": "EUR",
      "status": "PENDING"
    }
  ]
}

Retrieve a specific payoutMerchant

get

Retrieve specific payoutMerchant by payoutMerchantId (technical identifier)

Authorizations

Path parameters

payoutMerchantIdinteger · int32required

Unique technical identifier of the payoutMerchant

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/payout-merchants/{payoutMerchantId}'

200

401

403

default

{
  "payoutMerchantId": 4,
  "merchantPayoutMerchantId": "1234-azerty-56789",
  "solutionCode": "MPFRGE-S1YP",
  "reasonLabel": "payout for April 2023",
  "executionDate": "2023-04-22T06:00:00.000Z",
  "amount": 65,
  "currencyCode": "EUR",
  "status": "PENDING"
}

Delete a specific payoutMerchant

delete

To delete a payoutMerchant, Only payoutMerchant with PENDING status can be deleted

Path parameters

payoutMerchantIdinteger · int32required

Unique technical identifier of the payoutMerchant

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/payout-merchants/{payoutMerchantId}'

204

401

403

default

{}

The payoutMerchant has been deleted

Retrieve all payoutSeller

get

Retrieve the list of payoutSeller for a specific seller.

Authorizations

Path parameters

sellerIdinteger · int32required

Unique technical identifier of the seller

Query parameters

pagestring · default: "1"optional

Page number, starting from 1.

Example: 1

pageSizestring · default: "10"optional

A limit on the number of objects to be returned. Limit can range between 1 and 100.

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-sellers'

200

401

403

default

{
  "pageCount": 1,
  "payoutSellers": [
    {
      "payoutSellerId": 4,
      "merchantPayoutSellerId": "1234-azerty-56789",
      "solutionCode": "MPFRGE-S1YP",
      "reasonLabel": "payout for April 2023",
      "executionDate": "2023-04-22T06:00:00.000Z",
      "transfers": [
        {
          "merchantTransferId": "1234-azerty-56789",
          "payoutAmount": 65,
          "currencyCode": "EUR"
        }
      ],
      "payoutOrders": [
        {
          "merchantGlobalOrderId": "1234-azerty-56789",
          "payoutRequestedAmount": 65,
          "payoutEffectiveAmount": 20,
          "payoutResidualAmount": 0,
          "currencyCode": "EUR"
        }
      ],
      "payoutPayment": {
        "paymentStatus": "PENDING",
        "paymentAmount": 85,
        "currencyCode": "EUR"
      }
    }
  ]
}

Retrieve a specific payoutSeller

get

Retrieve specific payoutSeller by payoutSellerId (technical identifier)

Authorizations

Path parameters

sellerIdinteger · int32required

Unique technical identifier of the seller

payoutSellerIdinteger · int32required

Unique technical identifier of the payoutSeller

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-sellers/{payoutSellerId}'

200

401

403

default

{
  "payoutSellerId": 4,
  "merchantPayoutSellerId": "1234-azerty-56789",
  "solutionCode": "MPFRGE-S1YP",
  "reasonLabel": "payout for April 2023",
  "executionDate": "2023-04-22T06:00:00.000Z",
  "transfers": [
    {
      "merchantTransferId": "1234-azerty-56789",
      "payoutAmount": 65,
      "currencyCode": "EUR"
    }
  ],
  "payoutOrders": [
    {
      "merchantGlobalOrderId": "1234-azerty-56789",
      "payoutRequestedAmount": 65,
      "payoutEffectiveAmount": 20,
      "payoutResidualAmount": 0,
      "currencyCode": "EUR"
    }
  ],
  "payoutPayment": {
    "paymentStatus": "PENDING",
    "paymentAmount": 85,
    "currencyCode": "EUR"
  }
}

Delete a payoutSeller

delete

To delete a payoutSeller, Only payoutSeller with PENDING status can be deleted

Authorizations

Path parameters

sellerIdinteger · int32required

Unique technical identifier of the seller

payoutSellerIdinteger · int32required

Unique technical identifier of the payoutSeller

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-sellers/{payoutSellerId}'

204

401

403

default

{}

Retrieve all instances of payoutSellerAmount

get

Retrieve the list of payoutSellerAmount for a specific Seller.

Authorizations

Path parameters

sellerIdinteger · int32required

Unique technical identifier of the seller

Query parameters

pagestring · default: "1"optional

Page number, starting from 1.

Example: 1

pageSizestring · default: "10"optional

A limit on the number of objects to be returned. Limit can range between 1 and 100.

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-seller-amounts'

200

401

403

default

{
  "pageCount": 1,
  "payoutSellerAmounts": [
    {
      "payoutSellerAmountId": 4,
      "solutionCode": "MPFRGE-S1YP",
      "reasonLabel": "payout for April 2023",
      "executionDate": "2023-04-22T06:00:00.000Z",
      "payout": {
        "askedAmount": 65,
        "payoutAmount": 20,
        "payoutAvailableAmount": 0,
        "currencyCode": "EUR"
      },
      "payoutPayment": {
        "paymentStatus": "PENDING",
        "paymentAmount": 85,
        "currencyCode": "EUR"
      },
      "merchantPayoutSellerAmountId": "1234-azerty-56789"
    }
  ]
}

Retrieve a specific payoutSellerAmount

get

Retrieve specific payoutSellerAmount by payoutSellerAmountId (technical identifier)

Authorizations

Path parameters

sellerIdinteger · int32required

Unique technical identifier of the seller

payoutSellerAmountIdinteger · int32required

Unique technical identifier of payoutSellerAmount

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-seller-amounts/{payoutSellerAmountId}'

200

401

403

default

{
  "payoutSellerAmountId": 4,
  "solutionCode": "MPFRGE-S1YP",
  "reasonLabel": "payout for April 2023",
  "executionDate": "2023-04-22T06:00:00.000Z",
  "payout": {
    "askedAmount": 65,
    "payoutAmount": 20,
    "payoutAvailableAmount": 0,
    "currencyCode": "EUR"
  },
  "payoutPayment": {
    "paymentStatus": "PENDING",
    "paymentAmount": 85,
    "currencyCode": "EUR"
  },
  "merchantPayoutSellerAmountId": "1234-azerty-56789"
}

Delete the specified instance of payoutSellerAmount by payoutSellerAmountId

delete

To delete a payoutSellerAmount, Only payoutSellerAmount with PENDING status can be deleted

Authorizations

Path parameters

sellerIdinteger · int32required

Unique technical identifier of the seller

payoutSellerAmountIdintegerrequired

Unique technical identifier of payoutSellerAmount

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-seller-amounts/{payoutSellerAmountId}'

204

401

403

default

{}

Retrieve all accounts

get

Retrieve the list of accounts for a specific merchant.

Authorizations

Query parameters

pagestring · default: "1"optional

Page number, starting from 1.

Example: 1

pageSizestring · default: "10"optional

A limit on the number of objects to be returned. Limit can range between 1 and 100.

Example: 10

balanceExtractionDatestringoptional

Balances extraction date of the account values. Default value is the current date

accountTypestring · enumoptional

type of the account to consider.

Available options:

embeddedLinesboolean · default: falseoptional

when Lines are needed in the answer. Default value FALSE.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/accounts'

200

401

403

default

{
  "pageCount": 1,
  "accounts": [
    {
      "accountType": "SETTLEMENT",
      "balanceExtractionDate": "2023-04-22T06:00:00.000Z",
      "currentBalance": 9999.99,
      "forecastBalance": 4850,
      "currency": "EUR",
      "balancesHistory": {
        "openingBalance": 4500.1,
        "closingBalance": 6321.11,
        "date": "2023-04-22T06:00:00.000Z"
      },
      "lines": [
        {
          "lineId": 123456,
          "accountingEntry": "SETTLEMENT",
          "accountingLabel": "transfer or payment reason or other",
          "merchantGlobalOrderId": "1234-azerty-56789",
          "operationDate": "2023-04-22T06:00:00.000Z",
          "cashedDate": "2023-04-22T06:00:00.000Z",
          "isCashed": true,
          "lineType": "DEBIT",
          "amount": 65
        }
      ]
    }
  ]
}

Retrieve the seller accounts

get

Retrieve the accounts for a specific seller.

Authorizations

Path parameters

sellerIdinteger · int32required

Unique technical identifier of the seller

Query parameters

pagestring · default: "1"optional

Page number, starting from 1.

Example: 1

pageSizestring · default: "10"optional

A limit on the number of objects to be returned. Limit can range between 1 and 100.

Example: 10

balanceExtractionDatestringoptional

Balances extraction date of the account values. Default value is the current date

embeddedLinesboolean · default: falseoptional

when Lines are needed in the answer. Default value FALSE.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{sellerId}/accounts'

200

401

403

default

{
  "pageCount": 1,
  "accounts": [
    {
      "accountType": "SETTLEMENT",
      "balanceExtractionDate": "2023-04-22T06:00:00.000Z",
      "currentBalance": 9999.99,
      "forecastBalance": 4850,
      "currency": "EUR",
      "balancesHistory": {
        "openingBalance": 4500.1,
        "closingBalance": 6321.11,
        "date": "2023-04-22T06:00:00.000Z"
      },
      "lines": [
        {
          "lineId": 123456,
          "accountingEntry": "SETTLEMENT",
          "accountingLabel": "transfer or payment reason or other",
          "merchantGlobalOrderId": "1234-azerty-56789",
          "operationDate": "2023-04-22T06:00:00.000Z",
          "cashedDate": "2023-04-22T06:00:00.000Z",
          "isCashed": true,
          "lineType": "DEBIT",
          "amount": 65
        }
      ]
    }
  ]
}

Order demand from the merchant

post

Create a new instance of order by merchantGlobalOrderId.

Authorizations

Body

solutionCodestring · max: 11required

scaleexpert product identifier for marketplace services.
The given solutionCode must already be subscribed to by the marketplace.
solutionCode must match this format ^MP\w{4}-\w{4}$
Refer to the reference documentation for the marketPlace solution codes.

Example: MPFRGE-S1YP

merchantGlobalOrderIdstringrequired

External reference Id of the Order on the merchant side as a whole - as long as the items are not dispatched separately.

Example: 1234-azerty-56789

amountnumber · floatrequired

Total amount of the order

Example: 64

currencyCodestring · iso-4217 · min: 3 · max: 3required

Currency code applicable to prices based on ISO4217. 3 letter currency code

Example: EUR

orderTypestring · enumoptional

used to define the type of the order. Default value PURCHASE

Example: PURCHASE

Available options:

merchantBuyerIdstringrequired

External reference Id of the Buyer on the merchant side.

Example: 1234-azerty-56789

itemsobject[]optional

Items list belonging to the order

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/orders' \
  --header 'Content-Type: application/json' \
  --data '{
    "solutionCode": "MPFRGE-S1YP",
    "merchantGlobalOrderId": "1234-azerty-56789",
    "amount": 64,
    "currencyCode": "EUR",
    "orderType": "PURCHASE",
    "merchantBuyerId": "1234-azerty-56789",
    "items": [
      {
        "gtin": "7512345678915",
        "label": "Tea cup",
        "quantity": 4,
        "price": 15.55,
        "currencyCode": "EUR",
        "amount": 64
      }
    ]
  }'

201

401

403

default

{
  "orderId": 123456789
}

Order has been created

Update a specific order

patch

Update the amount of an order by orderId (technical identifier)

Authorizations

Path parameters

orderIdinteger · int32required

Unique technical identifier of the order

Body

solutionCodestring · max: 11required

scaleexpert product identifier for marketplace services.
The given solutionCode must already be subscribed to by the marketplace.
solutionCode must match this format ^MP\w{4}-\w{4}$
Refer to the reference documentation for the marketPlace solution codes.

Example: MPFRGE-S1YP

amountnumber · floatoptional

amount of the order

Example: 64

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/orders/{orderId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "solutionCode": "MPFRGE-S1YP",
    "amount": 64
  }'

200

401

403

default

{
  "orderId": 123456,
  "solutionCode": "MPFRGE-S1YP",
  "merchantGlobalOrderId": "1234-azerty-56789",
  "amount": 65.15,
  "currencyCode": "EUR",
  "orderType": "PURCHASE",
  "merchantBuyerId": "1234-azerty-56789",
  "registrationTimestamp": "2023-04-22T06:00:00.000Z",
  "lastUpdateTimestamp": "2023-04-22T06:00:00.000Z",
  "items": [
    {
      "gtin": "7512345678915",
      "label": "Tea cup",
      "quantity": 4,
      "price": 15.55,
      "currencyCode": "EUR",
      "amount": 64
    }
  ],
  "transactions": [
    {
      "transactionId": 123456789,
      "type": "PAYMENT",
      "executionDate": "2023-04-22T06:00:00.000Z",
      "amount": 64,
      "currencyCode": "EUR",
      "merchantTransactionId": "1234-azerty-56789",
      "paymentMethodName": "PAYXPERT_SG",
      "isPaid": true,
      "dueDate": "2017-07-21",
      "paidAmount": 65
    }
  ],
  "orderSplits": [
    {
      "splits": [
        {
          "sellerId": 123456789,
          "amount": 65,
          "amountType": "SELLER_PAYMENT",
          "fee": 65,
          "feeType": "MKTP_FEES",
          "currencyCode": "EUR",
          "model": "3P",
          "splitProducerFeeAmount": 65,
          "isCashed": true
        }
      ]
    }
  ],
  "payoutSellers": [
    {
      "payoutSellerId": 123456789,
      "merchantPayoutSellerId": "1234-azerty-56789",
      "reasonLabel": "payout for April 2023",
      "executionDate": "2023-04-22T06:00:00.000Z",
      "transfers": [
        {
          "merchantTransferId": "1234-azerty-56789",
          "payoutAmount": 65,
          "currencyCode": "EUR"
        }
      ],
      "payoutOrders": [
        {
          "payoutRequestedAmount": 65,
          "payoutEffectiveAmount": 20,
          "payoutResidualAmount": 0,
          "currencyCode": "EUR"
        }
      ],
      "payoutPayment": {
        "paymentStatus": "PENDING",
        "paymentAmount": 85,
        "currencyCode": "EUR"
      }
    }
  ]
}

The order has been updated

Apply an order-split by sellers

post

Split an order to allocate amounts to different sellers

Authorizations

Body

solutionCodestring · max: 11required

scaleexpert product identifier for marketplace services.
The given solutionCode must already be subscribed to by the marketplace.
solutionCode must match this format ^MP\w{4}-\w{4}$
Refer to the reference documentation for the marketPlace solution codes.

Example: MPFRGE-S1YP

merchantGlobalOrderIdstringrequired

External reference Id of the Order on the merchant side as a whole - as long as the items are not dispatched separately.

Example: 1234-azerty-56789

splitsobject[]required

splits related to the order

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/order-splits' \
  --header 'Content-Type: application/json' \
  --data '{
    "solutionCode": "MPFRGE-S1YP",
    "merchantGlobalOrderId": "1234-azerty-56789",
    "splits": [
      {
        "sellerId": 123456789,
        "amount": 65,
        "amountType": "SELLER_PAYMENT",
        "fee": 65.15,
        "feeType": "MKTP_FEES",
        "currencyCode": "EUR",
        "model": "3P"
      }
    ]
  }'

200

401

403

default

{}

OK Split has been applied

Register a transaction

post

Create a new instance of transaction related to the order.

Authorizations

Body

solutionCodestring · max: 11required

scaleexpert product identifier for marketplace services.
The given solutionCode must already be subscribed to by the marketplace.
solutionCode must match this format ^MP\w{4}-\w{4}$
Refer to the reference documentation for the marketPlace solution codes.

Example: MPFRGE-S1YP

merchantGlobalOrderIdstringrequired

External reference Id of the order on the merchant side as a whole - as long as the items are not dispatched separately.

Example: 1234-azerty-56789

merchantTransactionIdstringrequired

External reference Id of the transaction on the merchant side.

Example: 1234-azerty-56789

typestring · enumrequired

type of the transaction

Example: PAYMENT

Available options:

executionDatestringrequired

Transaction execution date. Using the ISO format in UTC YYYY-MM-DDThh:mm:ss.SSSZ

Example: 2023-04-22T06:00:00.000Z

amountnumber · floatrequired

Transaction amount

Example: 65

currencyCodestring · iso-4217 · min: 3 · max: 3required

Currency code applicable to prices based on ISO4217. 3 letter currency code

Example: EUR

paymentMethodNamestring · enumrequired

payment method name

Example: PAYXPERT_SG

Available options:

dueDatestringoptional

the date notation as yyyy-mm-dd.

Example: 2017-07-21

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/transactions' \
  --header 'Content-Type: application/json' \
  --data '{
    "solutionCode": "MPFRGE-S1YP",
    "merchantGlobalOrderId": "1234-azerty-56789",
    "merchantTransactionId": "1234-azerty-56789",
    "type": "PAYMENT",
    "executionDate": "2023-04-22T06:00:00.000Z",
    "amount": 65,
    "currencyCode": "EUR",
    "paymentMethodName": "PAYXPERT_SG",
    "dueDate": "2017-07-21"
  }'

201

401

403

default

{
  "transactionId": 321,
  "solutionCode": "MPFRGE-S1YP",
  "merchantGlobalOrderId": "1234-azerty-56789",
  "merchantTransactionId": "1234-azerty-56789",
  "orderId": 123456789,
  "type": "PAYMENT",
  "executionDate": "2023-04-22T06:00:00.000Z",
  "amount": 65,
  "currencyCode": "EUR",
  "paymentMethodName": "PAYXPERT_SG",
  "isPaid": true,
  "dueDate": "2017-07-21",
  "paidAmount": 65
}

The transaction has been created

Update a specific transaction

patch

Update the dueDate of a transaction by transactionId (technical identifier)

Authorizations

Path parameters

transactionIdinteger · int32required

Unique technical identifier of the transaction

Body

solutionCodestring · max: 11required

scaleexpert product identifier for marketplace services.
The given solutionCode must already be subscribed to by the marketplace.
solutionCode must match this format ^MP\w{4}-\w{4}$
Refer to the reference documentation for the marketPlace solution codes.

Example: MPFRGE-S1YP

dueDatestringoptional

the date notation as yyyy-mm-dd.

Example: 2017-07-21

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/transactions/{transactionId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "solutionCode": "MPFRGE-S1YP",
    "dueDate": "2017-07-21"
  }'

200

401

403

default

{
  "transactionId": 321,
  "solutionCode": "MPFRGE-S1YP",
  "merchantGlobalOrderId": "1234-azerty-56789",
  "merchantTransactionId": "1234-azerty-56789",
  "orderId": 123456789,
  "type": "PAYMENT",
  "executionDate": "2023-04-22T06:00:00.000Z",
  "amount": 65,
  "currencyCode": "EUR",
  "paymentMethodName": "PAYXPERT_SG",
  "isPaid": true,
  "dueDate": "2017-07-21",
  "paidAmount": 65
}

The transaction has been updated

Perform a transfer

post

Make a transfer for a seller account or a marketplace account for purposes such as the payment of a subscription, of a fee or for commercial gesture. The transfers are always initiated by the merchant (marketplace), wether they are in its favor or in the seller's favor.There can never be a transfer between two sellers.

Authorizations

Body

solutionCodestring · max: 11required

scaleexpert product identifier for marketplace services.
The given solutionCode must already be subscribed to by the marketplace.
solutionCode must match this format ^MP\w{4}-\w{4}$
Refer to the reference documentation for the marketPlace solution codes.

Example: MPFRGE-S1YP

accountingEntrystring · enumrequired

Identify the transfer way. TRANSFER_TO_MARKETPLACE is a payment from the seller to the marketplace. TRANSFER_TO_SELLER is the opposite

Example: TRANSFER_TO_MARKETPLACE

Available options:

reasonCodestring · enumrequired

Attach the transfer to a specific accounting category for reporting use

Example: SUBSCRIPTION

Available options:

reasonLabelstring · max: 140required

Label of the payout. Max 140 characters. Displayed to the receiver of funds.

Example: payout for April 2023

executionDatestringoptional

Transfer execution date. Using the ISO format in UTC YYYY-MM-DDThh:mm:ss.SSSZ. Current date by default.

amountnumber · floatrequired

Transfer Amount.

Example: 65.15

currencyCodestring · iso-4217 · min: 3 · max: 3required

Currency code applicable to prices based on ISO4217. 3 letter currency code

Example: EUR

sellerIdinteger · int32required

Unique internal identifier for a seller

Example: 123456789

merchantTransferIdstringrequired

External reference Id of the transfer on the merchant side.

Example: 9887975454

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/transfers' \
  --header 'Content-Type: application/json' \
  --data '{
    "solutionCode": "MPFRGE-S1YP",
    "accountingEntry": "TRANSFER_TO_MARKETPLACE",
    "reasonCode": "SUBSCRIPTION",
    "reasonLabel": "payout for April 2023",
    "executionDate": "text",
    "amount": 65.15,
    "currencyCode": "EUR",
    "sellerId": 123456789,
    "merchantTransferId": "9887975454"
  }'

201

401

403

default

{
  "transferId": 123456789,
  "sellerId": 123456789,
  "merchantTransferId": "9887975454",
  "solutionCode": "MPFRGE-S1YP",
  "accountingEntry": "TRANSFER_TO_MARKETPLACE",
  "reasonCode": "SUBSCRIPTION",
  "reasonLabel": "payout for April 2023",
  "executionDate": "text",
  "amount": 65.15,
  "currencyCode": "EUR",
  "status": "PENDING"
}

The transfer has been created

Perform a payoutMerchant

post

A payoutMerchant is used to transfer funds to the external bank account of the merchant (marketplace)

Authorizations

Body

merchantPayoutMerchantIdstringrequired

External reference Id of the payoutMerchant on the merchant side.

Example: 1234-azerty-56789

solutionCodestring · max: 11required

scaleexpert product identifier for marketplace services.
The given solutionCode must already be subscribed to by the marketplace.
solutionCode must match this format ^MP\w{4}-\w{4}$
Refer to the reference documentation for the marketPlace solution codes.

Example: MPFRGE-S1YP

reasonLabelstring · max: 140optional

Label of the payout. Max 140 characters. Displayed to the receiver of funds.

Example: payout for April 2023

executionDatestringoptional

Execution date. Using the ISO format in UTC YYYY-MM-DDThh:mm:ss.SSSZ. Current date by default

Example: 2023-04-22T06:00:00.000Z

amountnumber · floatrequired

Payout merchant amount

Example: 65

currencyCodestring · iso-4217 · min: 3 · max: 3required

Currency code applicable to prices based on ISO4217. 3 letter currency code

Example: EUR

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/payout-merchants' \
  --header 'Content-Type: application/json' \
  --data '{
    "merchantPayoutMerchantId": "1234-azerty-56789",
    "solutionCode": "MPFRGE-S1YP",
    "reasonLabel": "payout for April 2023",
    "executionDate": "2023-04-22T06:00:00.000Z",
    "amount": 65,
    "currencyCode": "EUR"
  }'

201

401

403

default

{
  "payoutMerchantId": 4,
  "merchantPayoutMerchantId": "1234-azerty-56789",
  "solutionCode": "MPFRGE-S1YP",
  "reasonLabel": "payout for April 2023",
  "executionDate": "2023-04-22T06:00:00.000Z",
  "amount": 65,
  "currencyCode": "EUR",
  "status": "PENDING"
}

The payoutMerchant has been created

Perform a payoutSeller

post

A payoutSeller is used to transfer funds to the external bank account of the Seller.

Authorizations

Path parameters

sellerIdinteger · int32required

Unique technical identifier of the seller

Body

solutionCodestring · max: 11required

scaleexpert product identifier for marketplace services.
The given solutionCode must already be subscribed to by the marketplace.
solutionCode must match this format ^MP\w{4}-\w{4}$
Refer to the reference documentation for the marketPlace solution codes.

Example: MPFRGE-S1YP

reasonLabelstring · max: 140required

Label of the payout. Max 140 characters. Displayed to the receiver of funds.

Example: payout for April 2023

executionDatestringoptional

Execution date. Using the ISO format in UTC YYYY-MM-DDThh:mm:ss.SSSZ. Current date by default

Example: 2023-04-22T06:00:00.000Z

transfersobject[]optional

Tnsfer related to the seller. if not specified the default value will be the total pending transfers amount

payoutOrdersobject[]optional

Order related to the seller. if not specified the default value will be the total of all pending orders amount

merchantPayoutSellerIdstringrequired

External reference Id of the payoutSeller on the merchant side.

Example: 1234-azerty-56789

currencyCodestring · iso-4217 · min: 3 · max: 3required

Currency code applicable to prices based on ISO4217. 3 letter currency code

Example: EUR

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-sellers' \
  --header 'Content-Type: application/json' \
  --data '{
    "solutionCode": "MPFRGE-S1YP",
    "reasonLabel": "payout for April 2023",
    "executionDate": "2023-04-22T06:00:00.000Z",
    "transfers": [
      {
        "merchantTransferId": "1234-azerty-56789"
      }
    ],
    "payoutOrders": [
      {
        "merchantGlobalOrderId": "1234-azerty-56789",
        "payoutRequestedAmount": 65
      }
    ],
    "merchantPayoutSellerId": "1234-azerty-56789",
    "currencyCode": "EUR"
  }'

201

401

403

default

{
  "payoutSellerId": 4,
  "merchantPayoutSellerId": "1234-azerty-56789",
  "solutionCode": "MPFRGE-S1YP",
  "reasonLabel": "payout for April 2023",
  "executionDate": "2023-04-22T06:00:00.000Z",
  "transfers": [
    {
      "merchantTransferId": "1234-azerty-56789",
      "payoutAmount": 65,
      "currencyCode": "EUR"
    }
  ],
  "payoutOrders": [
    {
      "merchantGlobalOrderId": "1234-azerty-56789",
      "payoutRequestedAmount": 65,
      "payoutEffectiveAmount": 20,
      "payoutResidualAmount": 0,
      "currencyCode": "EUR"
    }
  ],
  "payoutPayment": {
    "paymentStatus": "PENDING",
    "paymentAmount": 85,
    "currencyCode": "EUR"
  }
}

The payoutSeller has been created

Create a payoutSellerAmount

post

A payoutSeller is used to transfer funds to the external bank account of the Seller from an amount.

Authorizations

Path parameters

sellerIdinteger · int32required

Unique technical identifier of the seller

Body

solutionCodestring · max: 11required

scaleexpert product identifier for marketplace services.
The given solutionCode must already be subscribed to by the marketplace.
solutionCode must match this format ^MP\w{4}-\w{4}$
Refer to the reference documentation for the marketPlace solution codes.

Example: MPFRGE-S1YP

reasonLabelstring · max: 140required

Label of the payout. Max 140 characters. Displayed to the receiver of funds.

Example: payout for April 2023

executionDatestringoptional

Execution date. Using the ISO format in UTC YYYY-MM-DDThh:mm:ss.SSSZ. Current date by default

Example: 2023-04-22T06:00:00.000Z

payoutobjectoptional

Payout amount. Dafault value will be the available amount

merchantPayoutSellerAmountIdstringrequired

External reference Id of the payoutSellerAmount on the merchant side.

Example: 1234-azerty-56789

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-seller-amounts' \
  --header 'Content-Type: application/json' \
  --data '{
    "solutionCode": "MPFRGE-S1YP",
    "reasonLabel": "payout for April 2023",
    "executionDate": "2023-04-22T06:00:00.000Z",
    "payout": {
      "askedAmount": 65,
      "currencyCode": "EUR"
    },
    "merchantPayoutSellerAmountId": "1234-azerty-56789"
  }'

201

401

403

default

{
  "payoutSellerAmountId": 4,
  "solutionCode": "MPFRGE-S1YP",
  "reasonLabel": "payout for April 2023",
  "executionDate": "2023-04-22T06:00:00.000Z",
  "payout": {
    "askedAmount": 65,
    "payoutAmount": 20,
    "payoutAvailableAmount": 0,
    "currencyCode": "EUR"
  },
  "payoutPayment": {
    "paymentStatus": "PENDING",
    "paymentAmount": 85,
    "currencyCode": "EUR"
  },
  "merchantPayoutSellerAmountId": "1234-azerty-56789"
}

The payoutSellerAmount has been created

Orders

OrderSplits

Transactions

Transferts

PayoutMerchants

PayoutSellers

PayoutSellerAmounts

Accounts

Orders

OrderSplits

Transactions

Transferts

PayoutMerchants

PayoutSellers

PayoutSellerAmounts

Accounts

Retrieve all orders

Delete a specific order

Retrieve a specific transaction

Retrieve all transactions

Delete a specific transaction

Retrieve all Transfers

Retrieve a specific transfers

Delete a specific transfer

Retrieve all payoutMerchants

Retrieve a specific payoutMerchant

Delete a specific payoutMerchant

Retrieve all payoutSeller

Retrieve a specific payoutSeller

Delete a payoutSeller

Retrieve all instances of payoutSellerAmount

Retrieve a specific payoutSellerAmount

Delete the specified instance of payoutSellerAmount by payoutSellerAmountId

Retrieve all accounts

Retrieve the seller accounts

Order demand from the merchant

Show child attributes

Update a specific order

Apply an order-split by sellers

Show child attributes

Register a transaction

Update a specific transaction

Perform a transfer

Perform a payoutMerchant

Perform a payoutSeller

Show child attributes

Show child attributes

Create a payoutSellerAmount

Show child attributes