POST
/
easy-split
/
orders
/
{order_id}
/
split
curl --request POST \
  --url https://sandbox.cashfree.com/pg/easy-split/orders/{order_id}/split \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "split": [
    {
      "vendor_id": "test03",
      "percentage": 10,
      "tags": {
        "product": "Dri-Fit trouser",
        "size": "L",
        "AWB": "NIKE12334"
      }
    }
  ],
  "disable_split": true
}'
{
  "message": "Order split created",
  "status": "OK"
}

Authorizations

ā€‹
x-client-id
string
headerrequired

Client app ID. You can find your app id in the Merchant Dashboard.

ā€‹
x-client-secret
string
headerrequired

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

ā€‹
x-api-version
string
default: 2023-08-01required

API version to be used. Format is in YYYY-MM-DD

ā€‹
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

ā€‹
x-idempotency-key
string

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Path Parameters

ā€‹
order_id
string
required

The id which uniquely identifies your order

Body

application/json

Split After Payment Request

ā€‹
split
object[]
required

Specify the vendors order split details.

ā€‹
disable_split
boolean

Specify if you want to end the split or continue creating further splits in future.

Response

200 - application/json

Split After Payment Response

ā€‹
status
string
ā€‹
message
string

Was this page helpful?

Create Static Split ConfigurationCreate On Demand Transfer