EnKash API Document
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Settlements
  • Payment Gateway Overview
  • Payment Gateway Sign Up
  • Payment Methods
  • Supported Integrations
  • Payment APIs
  • Test Card Details
  • Authorization
    • About Authorization
    • Get Authorization Token
      POST
  • Orders
    • Order Overview
    • About Order
    • Create Order
      POST
    • Get Order Status
      GET
    • Get BNPL Payment Modes
      GET
  • Payments
    • Payment Overview
    • About Payment
    • Get Transaction Status
      GET
    • Submit Payment Detail
      POST
  • Refunds
    • About Refund
    • Refund
      POST
  • Payment Links
    • Upi Intent Link Detail
      GET
  • Settlements
    • About Settlement
    • Get Settlement Payout By Id
      GET
    • Search Settlement Payouts
      POST
  • QR Generation API
    • Get Dynamic QR Code
  • Payment Button
  • Qr Code
    • Create QR
    • Create QR Customer
    • Search QR Code
    • Get QR Code
    • Cancel QR Code
  1. Settlements

Get Settlement Payout By Id

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

Request

Path Params

Header Params

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

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 2024-07-30 10:44:09
Previous
About Settlement
Next
Search Settlement Payouts
Built with