Endpoints orders management

Orders

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: PURCHASEPossible values:

merchantBuyerIdstringRequired

External reference Id of the Buyer on the merchant side.

Example: 1234-azerty-56789

Responses

201

Order has been created

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

post

HTTPcURLJavaScriptPython

POST /baas/uatc/marketplace/api/v1/orders HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 281

{
  "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
    }
  ]
}

{
  "orderId": 123456789
}

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

200

The order has been updated

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /baas/uatc/marketplace/api/v1/orders/{orderId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "solutionCode": "MPFRGE-S1YP",
  "amount": 64
}

{
  "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"
      }
    }
  ]
}

Retrieve all orders

get

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

Authorizations

Query parameters

pagestringOptional

Page number, starting from 1.

Default: 1Example: 1

pageSizestringOptional

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

Default: 10Example: 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

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/orders HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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

204

The order has been deleted

application/json

Responseobject

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /baas/uatc/marketplace/api/v1/orders/{orderId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{}

OrderSplits

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

Responses

200

OK Split has been applied

application/json

Responseobject

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

post

HTTPcURLJavaScriptPython

POST /baas/uatc/marketplace/api/v1/order-splits HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "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"
    }
  ]
}

{}

Transactions

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: PAYMENTPossible values:

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_SGPossible values:

dueDatestringOptional

the date notation as yyyy-mm-dd.

Example: 2017-07-21

Responses

201

The transaction has been created

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

post

HTTPcURLJavaScriptPython

POST /baas/uatc/marketplace/api/v1/transactions HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "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"
}

{
  "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
}

Retrieve a specific transaction

get

Retrieve a transaction by transactionId (technical identifier)

Authorizations

Path parameters

transactionIdinteger · int32Required

Unique technical identifier of the transaction

Responses

200

List of Transactions

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/transactions/{transactionId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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
}

Retrieve all transactions

get

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

Authorizations

Query parameters

pagestringOptional

Page number, starting from 1.

Default: 1Example: 1

pageSizestringOptional

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

Default: 10Example: 10

Responses

200

List of Transactions

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/transactions HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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
    }
  ]
}

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

200

The transaction has been updated

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /baas/uatc/marketplace/api/v1/transactions/{transactionId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "solutionCode": "MPFRGE-S1YP",
  "dueDate": "2017-07-21"
}

{
  "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
}

Delete a specific transaction

delete

Delete a transaction by transactionId (technical identifier)

Authorizations

Path parameters

transactionIdinteger · int32Required

Unique technical identifier of the transaction

Responses

204

The transaction has been deleted

application/json

Responseobject

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /baas/uatc/marketplace/api/v1/transactions/{transactionId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{}

Transferts

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_MARKETPLACEPossible values:

reasonCodestring · enumRequired

Attach the transfer to a specific accounting category for reporting use

Example: SUBSCRIPTIONPossible values:

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

201

The transfer has been created

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

post

HTTPcURLJavaScriptPython

POST /baas/uatc/marketplace/api/v1/transfers HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "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"
}

{
  "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 all Transfers

get

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

Authorizations

Query parameters

pagestringOptional

Page number, starting from 1.

Default: 1Example: 1

pageSizestringOptional

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

Default: 10Example: 10

Responses

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/transfers HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/transfers/{transferId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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

204

OK

application/json

Responseobject

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /baas/uatc/marketplace/api/v1/transfers/{transferId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{}

PayoutMerchants

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

201

The payoutMerchant has been created

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

post

HTTPcURLJavaScriptPython

POST /baas/uatc/marketplace/api/v1/payout-merchants HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 191

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

{
  "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 all payoutMerchants

get

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

Authorizations

Query parameters

pagestringOptional

Page number, starting from 1.

Default: 1Example: 1

pageSizestringOptional

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

Default: 10Example: 10

Responses

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/payout-merchants HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/payout-merchants/{payoutMerchantId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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

204

The payoutMerchant has been deleted

application/json

Responseobject

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /baas/uatc/marketplace/api/v1/payout-merchants/{payoutMerchantId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{}

PayoutSellers

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

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

201

The payoutSeller has been created

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

post

HTTPcURLJavaScriptPython

POST /baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-sellers HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 324

{
  "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"
}

{
  "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 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

pagestringOptional

Page number, starting from 1.

Default: 1Example: 1

pageSizestringOptional

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

Default: 10Example: 10

Responses

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-sellers HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-sellers/{payoutSellerId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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

204

OK

application/json

Responseobject

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-sellers/{payoutSellerId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{}

PayoutSellerAmounts

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

merchantPayoutSellerAmountIdstringRequired

External reference Id of the payoutSellerAmount on the merchant side.

Example: 1234-azerty-56789

Responses

201

The payoutSellerAmount has been created

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

post

HTTPcURLJavaScriptPython

POST /baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-seller-amounts HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "solutionCode": "MPFRGE-S1YP",
  "reasonLabel": "payout for April 2023",
  "executionDate": "2023-04-22T06:00:00.000Z",
  "payout": {
    "askedAmount": 65,
    "currencyCode": "EUR"
  },
  "merchantPayoutSellerAmountId": "1234-azerty-56789"
}

{
  "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 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

pagestringOptional

Page number, starting from 1.

Default: 1Example: 1

pageSizestringOptional

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

Default: 10Example: 10

Responses

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-seller-amounts HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-seller-amounts/{payoutSellerAmountId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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

204

OK

application/json

Responseobject

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /baas/uatc/marketplace/api/v1/sellers/{sellerId}/payout-seller-amounts/{payoutSellerAmountId} HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{}

Accounts

Retrieve all accounts

get

Retrieve the list of accounts for a specific merchant.

Authorizations

Query parameters

pagestringOptional

Page number, starting from 1.

Default: 1Example: 1

pageSizestringOptional

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

Default: 10Example: 10

balanceExtractionDatestringOptional

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

accountTypestring · enumOptional

type of the account to consider.

Possible values:

embeddedLinesbooleanOptional

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

Default: false

Responses

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/accounts HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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

pagestringOptional

Page number, starting from 1.

Default: 1Example: 1

pageSizestringOptional

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

Default: 10Example: 10

balanceExtractionDatestringOptional

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

embeddedLinesbooleanOptional

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

Default: false

Responses

200

OK

application/json

401

Unauthorized. You must first authenticate to get a valid token.

application/json

403

Scope missing or insufficient permissions.

application/json

default

Generic Error

application/json

get

HTTPcURLJavaScriptPython

GET /baas/uatc/marketplace/api/v1/sellers/{sellerId}/accounts HTTP/1.1
Host: api.scalexpert.uatc.societegenerale.com
Accept: */*

{
  "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
        }
      ]
    }
  ]
}