POST
/
easy-split
/
static-split
curl --request POST \
  --url https://sandbox.cashfree.com/pg/easy-split/static-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 '{
  "active": true,
  "terminal_id": 0,
  "product_type": "PG",
  "scheme": [
    {
      "merchant_vendor_id": "EsTest1Success",
      "percentage": 10
    }
  ]
}'
{
  "product_type": "PG",
  "terminal_id": 0,
  "terminal_reference_id": null,
  "active": true,
  "scheme": [
    {
      "merchant_vendor_id": "EsTest1Success",
      "percentage": 10
    }
  ],
  "added_on": "2023-06-08 15:45:46"
}

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.

Body

application/json

Static Split Request

ā€‹
active
boolean
required

Specify if the split is to be active or not. Possible values: true/false

ā€‹
product_type
string
required

Specify the product for which the split should be created. If you want split to be created for Payment Gateway pass value as "PG". If you want split to be created for Subscription, pass value as "SBC". Accepted values - "STATIC_QR", "SBC", "PG", "EPOS".

ā€‹
scheme
object[]
required

Provide the split scheme details.

ā€‹
terminal_id
string

For Subscription payments, the subscription reference ID is to be shared as the terminal ID. Incase for Payment Gateway terminal ID is non-mandatory. Mention as 0 if not applicable.

ā€‹
terminal_reference_id
number

You can share additional information using the reference ID.

Response

200 - application/json

Static Split Response

ā€‹
active
boolean
ā€‹
terminal_id
string
ā€‹
terminal_reference_id
number
ā€‹
product_type
string
ā€‹
scheme
object[]
ā€‹
added_on
string

Was this page helpful?

Get On Demand BalanceSplit After Payment