- Explore Our Product Suite
- Payment Gateway
- Payment Gateway Overview
- Getting Started
- Payment Methods
- Integration
- API Endpoints
- APIs
- Authorisation
- Order
- Payment
- Refund
- Settlement
- Split Settlement
- E-Commerce Plugins
- Payment Button
- Qr Code
- UPI Mandate
- Payment Links
- Authorisation
- Payouts
- Prepaid Cards
- About Prepaid Card
- Key Capabilities
- Getting Started
- APIs
- API Access & Authorization
- Encryption & Decryption Guide
- Auth Token
- Create Card Account
- Create Gift Card
- Create Prepaid Card
- Set Card PIN
- Load Card Balance
- Get Card Account Details
- Generate Card OTP
- View Card Details
- Card Usage Controls
- Get Card Usage Limits
- Request Card Replacement
- Block Card
- Order Physical Card
- Get Card Details
- Get Transaction Details
- Get All Transaction details
- Bharat Connect (BBPS)
- About Bharat Connect
- Invoice Payments
- Invoice
- Payment
- Financing
- Onboarding
- cdNote
- Purchase Order
- webhook-invoice
- webhook-payments
- webhook-business-onboarding
- webhook-financing
- webhook-cdNote
- Webhook Purchase Order
- Webhook Send Purchase Order Request
- Webhook Send Purchase Order Response
- Webhook Confirm Purchase Order Request
- Webhook Confirm Purchase Order Response
- Webhook Edit Purchase Order Request
- Webhook Edit Purchase Order Response
- Webhook Status Change Purchase Order Request
- Webhook Status Change Purchase Order Response
- Bill Payments
- Accounts Payable
- Account Receivable
- Expense Management
- Rewards & Incentives
- Verification Suite
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"
}
]
}
}