JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Update Split

If the transaction was initiated with the split type set as "later," this API can be utilized to declare the split for the original transaction after it has been completed.

Request

Response

API Endpoints

Production Link

POST

{{host}}/api/{{uri}}/merchants/transactions/settlement/split

                      Basic Auth
                      *
                      

required

                      jpupi-routing-id
                      *
                      

String

Mandatory

Header value should be same as of merchantRequestId sent in request body

Body

Request Schema: application/json

                      merchantRequestId
                      *
                      

String

Mandatory

merchantRequestId of original request

                      splitSettlementDetails
                      *
                      

String

Mandatory

The split settlement details shared by merchant

                      splitType
                      *
                      

String

Mandatory

The type of split for this transaction. Can be AMOUNT, PERCENTAGE, DEFAULT, LATER.

                      merchantSplit
                      
                      

String

Conditional

Split share for merchant pool account.

                      partnersSplit
                      
                      

String

Conditional

List of partners for which the split needs to be divided with the value.

                      partnerId
                      *
                      

String

Mandatory

The LSP id provided by the bank.

                      value
                      *
                      

String

Mandatory

Split share for LSP account. Decimal Value.

                      udfParameters
                      
                      

Stringified JSON

Optional

Merchant Defined Parameters

Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"

Note: Few special characters are not allowed. Regex for the characters which are not allowed : ^[^/#-()*!%~`]+$

Response Body

                      status
                      *
                      

String

Mandatory

API status

                      responseCode
                      *
                      

String

Mandatory

API Response Code

                      responseMessage
                      *
                      

String

Mandatory

API Response Message

                      payload
                      *
                      

String

Mandatory

                      merchantId
                      *
                      

String

Mandatory

merchantId of the merchant

                      merchantChannelId
                      *
                      

String

Mandatory

merchanChanneltId of the merchant

                      merchantRequestId
                      *
                      

String

Mandatory

merchantRequestId of original request (As sent in request body)

                      splitSettlementDetails
                      *
                      

String

Mandatory

The split settlement details shared by merchant (As sent in request body)

                      merchantSplit
                      
                      

String

Conditional

Split share for merchant pool account.

                      partnersSplit
                      
                      

String

Conditional

List of partners for which the split needs to be divided with the value.

                      partnerId
                      *
                      

String

Mandatory

The LSP id provided by the bank.

                      value
                      *
                      

String

Mandatory

Split share for LSP account. Decimal Value.

                      customerSplit
                      
                      

String

Conditional

Denotes the amount of refund issued to the customer.

                      splitType
                      *
                      

String

Mandatory

The type of split for this transaction. Can be AMOUNT, PERCENTAGE, DEFAULT, LATER.

                      udfParameters
                      
                      

Stringified JSON

Optional

Udf parameters as passed in the request.
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"

Have questions?
Need help? Contact support
LLM? Read llms.txt