Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Split Settlements
  • Payment Gateway Overview
  • Payment Gateway Sign Up
  • Payment Methods
  • Supported Integrations
  • Payment Gateway APIs
  • Web Integration
  • Server to Server Integration
  • Test Card Details
  • Authorization
    • About Authorization
    • Get Authorization Token
      POST
  • Orders
    • About Order
    • Create Order
      POST
    • Get Order Status
      GET
    • Get BNPL Payment Modes
      GET
    • Get Dynamic QR Code
      GET
    • UPI Intent Links
      GET
    • Get UPI Transaction Status
      GET
  • Payments
    • About Payment
    • Submit Payment Detail
      POST
    • Get Transaction Status
      GET
    • Validate OTP
      POST
    • Resend OTP
      GET
    • Payment Notify Request
      POST
  • Refunds
    • About Refund
    • Refund
  • Settlements
    • About Settlement
    • Settlement Reporting
    • Get Settlement Payout By ID
    • Search Settlement Payouts
  • Split Settlements
    • About Split Settlements
    • Create Split Settlement Account
      POST
    • Update Split Settlement Account
      POST
    • Get All Split Settlement Account
      GET
    • Deactivate Split Settlement Account
      PATCH
    • Activate Split Settlement Account
      PATCH
    • Submit Payment with Split Details
      POST
    • Edit/Deferred Split Settlement
      POST
  • E-Commerce Plugins
  • Payment Links
  • Payment Button
  • Qr Code
    • Create Qr Code
    • Get QR Code
    • Search QR Code
    • createCustomer
    • searchCustomer
    • Cancel QR Code
  • UPI Mandate
    • Create UPI Mandate
    • Update UPI Mandate
    • Revoke UPI Mandate
    • Get UPI Mandate
    • UPI mandate create callback
    • Mandate Pre-debit Notification
    • Execute mandate debit
    • Mandate Debit callback
  1. Split Settlements

Submit Payment with Split Details

POST
/api/v0/payment/submit
order-controller

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
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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 2024-11-22 05:21:25
Previous
Activate Split Settlement Account
Next
Edit/Deferred Split Settlement
Built with