Submit Payment with Split Details

POST

/api/v0/payment/submit

📌

Use this API to initiate a payment while specifying split rules, so funds are automatically distributed across multiple accounts in a single transaction.

Request

Header Params

Authorization

string

required

merchantAccessKey

string

required

Body Params application/json

orderId

string

required

paymentDetail

object (PaymentDetailDTO)

optional

paymentMode

enum<string> | enum<null>

required

Allowed values:

NET_BANKINGUPICREDIT_CARDDEBIT_CARDPREPAID_CARDPAY_LATERWALLETCORPORATE_CARD

cardHolderName

string

optional

Required for Cards Payment Mode

cardNumber

string

optional

Required for Cards Payment Mode

cvv

string

optional

Required for Cards Payment Mode

expiry

string

optional

Required for Cards Payment Mode

bankCode

string

optional

Required for NetBanking, BNPL, Wallet Payment Modes

bnplPaymentOptionId

string

optional

Required for BNPL Payment Mode

vpa

string

optional

Required for UPI Payment Mode

tokenCryptogram

string

optional

Required for Cards Payment Mode

tokenRequestorId

string

optional

Required for Cards Payment Mode

tokenExpiry

string

optional

Required for Cards Payment Mode

splitSettlement

object (SplitSettlementDTO)

required

amountSplitType

enum<string>

required

Allowed values:

FLATPERCENTAGE

splitSettlementDetails

array[object (SplitSettlementDetail) {2}]

required

Example

{
  "orderId": "string",
  "paymentDetail": {
    "paymentMode": "NET_BANKING",
    "cardHolderName": "string",
    "cardNumber": "string",
    "cvv": "string",
    "expiry": "string",
    "bankCode": "string",
    "bnplPaymentOptionId": "string",
    "vpa": "string"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v0/payment/submit' \
--header 'Authorization;' \
--header 'merchantAccessKey;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "orderId": "string",
  "paymentDetail": {
    "paymentMode": "NET_BANKING",
    "cardHolderName": "string",
    "cardNumber": "string",
    "cvv": "string",
    "expiry": "string",
    "bankCode": "string",
    "bnplPaymentOptionId": "string",
    "vpa": "string"
  }
}'

Responses

🟢200OK

application/json

Body

response_code

integer <int32>

optional

response_message

string

optional

payload

object (OrderPaymentSubmitResponse)

optional

redirectionUrl

string

optional

transactionId

string

optional

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "redirectionUrl": "string",
        "transactionId": "string"
    }
}

Modified at 2025-07-05 11:54:45

Activate Split Settlement Account

Edit Or Deferred Split Settlement