Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. 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
      GET
    • Search Settlement Payouts
      POST
  • Split Settlements
    • About Split Settlements
    • Create Split Settlement Account
    • Update Split Settlement Account
    • Get All Split Settlement Account
    • Deactivate Split Settlement Account
    • Activate Split Settlement Account
    • Submit Payment with Split Details
    • Edit/Deferred Split Settlement
  • 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. Settlements

Get Settlement Payout By ID

GET
/api/v0/settlement-payout/{settlementPayoutId}

Request

Path Params
settlementPayoutId
string 
required
Header Params
Authorization
string 
required
merchantAccessKey
string 
required

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 GET '/api/v0/settlement-payout/' \
--header 'Authorization;' \
--header 'merchantAccessKey;'

Responses

🟢200OK
application/json
Body
response_code
integer <int32>
optional
response_message
string 
optional
payload
object (SettlementPayoutDetailResponse) 
optional
settlementPayoutId
string 
optional
totalSaleAmount
number 
optional
totalRefundAmount
number 
optional
totalCharges
number 
optional
totalGst
number 
optional
totalSettlementAmount
number 
optional
refundChargebackAmount
number 
optional
carryForwardAmount
number 
optional
adjustmentAmount
number 
optional
payoutStatus
enum<string> 
optional
Allowed values:
INITSUCCESSFAILEDIN_PROGRESSON_HOLD
payoutMode
enum<string> 
optional
Allowed values:
IMPSNEFTRTGS
utr
string 
optional
payoutDate
string <date-time>
optional
remarks
string 
optional
payoutRemarks
string 
optional
transferId
string 
optional
transferResponseReason
string 
optional
createdOn
string <date-time>
optional
modifiedOn
string <date-time>
optional
settlementTransactionResponses
array[object (SettlementTransactionResponse) {25}] 
optional
Example
{
  "response_code": 0,
  "response_message": "string",
  "payload": {
    "settlementPayoutId": "string",
    "totalSaleAmount": 0,
    "totalRefundAmount": 0,
    "totalCharges": 0,
    "totalGst": 0,
    "totalSettlementAmount": 0,
    "refundChargebackAmount": 0,
    "carryForwardAmount": 0,
    "adjustmentAmount": 0,
    "payoutStatus": "INIT",
    "payoutMode": "IMPS",
    "utr": "string",
    "payoutDate": "2019-08-24T14:15:22Z",
    "remarks": "string",
    "payoutRemarks": "string",
    "transferId": "string",
    "transferResponseReason": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "settlementTransactionResponses": [
      {
        "id": 0,
        "settlementTransactionId": "string",
        "saleAmount": 0,
        "txnAmount": 0,
        "taxAmount": 0,
        "charges": 0,
        "settlementAmount": 0,
        "transactionType": "SALE",
        "settlementStatus": "PENDING",
        "remarks": "string",
        "acquirerAmountRate": 0,
        "acquirerFlatAmountRate": 0,
        "acquirerNetAmount": 0,
        "acquirerGstAmount": 0,
        "merchantMdrMode": "CONVENIENCE",
        "merchantMdr": 0,
        "merchantFlatMdr": 0,
        "merchantPercentagePlatformFee": 0,
        "merchantFlatPlatformFee": 0,
        "merchantPercentageConvenienceFee": 0,
        "merchantFlatConvenienceFee": 0,
        "netProfit": 0,
        "profitGst": 0,
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z"
      }
    ]
  }
}
Modified at 2025-01-09 20:26:11
Previous
Settlement Reporting
Next
Search Settlement Payouts
Built with