API · Split settlement

API v1
POST /api/v1/orders/liquidation/split

What it does#

Splits the settlement of an order among several merchants. It only applies to merchants that use Tilopay as a payment facilitator, and the resulting orders are identified by the SL| prefix.

Rules:

  • The merchants must be approved and be from the same country.
  • If the split is lower than the total amount of the order, the remainder is assigned to the merchant that made the original transaction.
  • It only applies to fully approved orders.

Authentication#

Requires the API bearer token in the Authorization header — see authentication.

Parameters#

order_idstring#

Id of the order approved in Tilopay.

commercesarray#

Associative array with the email and amount keys of every merchant the settlement is divided with. Including the owner merchant is optional: when its amount is not specified the remainder of the split is assigned to it, and when it is included and there is a remainder, the remainder is added to it.

langstring#

Request language.

Request example#

The <...> values are placeholders: replace them with your own credentials and data.

{
  "order_id": "1",
  "commerces": [
    {
      "email": "commerce-1@example.com",
      "amount": "7.5"
    },
    {
      "email": "commerce-2@example.com",
      "amount": "5.5"
    }
  ],
  "lang": "en"
}

Response#

{
  "type": "200",
  "message": "Great",
  "description": "Order splitted successfully",
  "response": {
    "total_order_splitted": 3,
    "order_id": 1,
    "order_number": "PFC000069-TYP785237_313",
    "order_key": "<api_key>",
    "order_currency": "USD",
    "order_amount": "33.00",
    "splitted_orders": [
      {
        "id": 1,
        "amount": 20,
        "commerce_name": "Commerce owner name",
        "commerce_email": "owner@example.com"
      },
      {
        "id": 2,
        "amount": 7.5,
        "commerce_name": "Commerce name",
        "commerce_email": "commerce-1@example.com"
      },
      {
        "id": 3,
        "amount": 5.5,
        "commerce_name": "Commerce name",
        "commerce_email": "commerce-2@example.com"
      }
    ]
  }
}

To interpret a response that is not a success, see how to read an error response.

Last verified: 2026-08-29 · Owner: equipo-integraciones

View as raw Markdown