Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Split Settlement
  • Payment Gateway Overview
  • Getting Started
  • Payment Methods
  • Integration
  • Payment Gateway APIs
    • Authorisation
      • Get Authorization Token
    • Order
      • Create Order
      • Get Order Status
      • Get Order By Merchant Order Id
      • Get BNPL Payment Methods
      • Get Dynamic UPI QR
      • UPI Intent Links
    • Payment
      • Submit Payment Request
      • Get Transaction Status
      • Validate OTP
      • Resend OTP
      • Payment Notify Request
      • Get UPI Transaction Status
      • Verify UPI VPA
    • Refund
      • Refund
    • Settlement
      • Settlement Reporting
      • Get Settlement Payout By ID
      • Search Settlement Payouts
    • Split Settlement
      • 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 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 callback
      • Mandate Pre-debit Notification
      • Execute mandate debit
      • Mandate Debit callback
    • Payment Links
      • Payment Links Overview
      • Payment Link APIs
      • Payment Link
        • Create Payment Link
        • Get Payment Link Details
        • Delete Payment Link
      • Payment Link Webhook
        • Payment Link Webhook Request
  1. Split Settlement

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
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
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