POSTSettlement Order Detail API
Use Case
This API retrieves settlement details at order level based on payout date and orderId. It provides information about transaction type and settlement details of that particular order.
Note: This API can be used only on production environment.
Merchant Authentication
For Authentication, JWT tokenization is used, please click here for more details.
Request Attributes
Head
| ATTRIBUTE | DESCRIPTION |
|---|---|
| reqMsgId mandatory |
The request message id Example : 9b688fce-c59f-4ead-9677-c38a43e3ab59 Note: For creating reqMsgId, please refer this link. |
Body
Order Level Based on Order ID
| ATTRIBUTE | DESCRIPTION |
|---|---|
| mid mandatory |
Unique merchantId Example: HelloM8xxxxxxxx45 |
| orderId mandatory |
Unique reference ID for a transaction generated by merchant Example: 20xxxxxxxxxxxx098 |
| transactionDate mandatory |
Order created date Example: 2022-07-05 |
Response Attributes
Head
| ATTRIBUTE | DESCRIPTION |
|---|---|
| reqMsgId | The request message id Example : 9b688fce-c59f-4ead-9677-c38a43e3ab59 |
| respTime | Time at which response is being sent Example : 2022-09-09T11:28:41+05:30 |
Body
| ATTRIBUTE | DESCRIPTION |
|---|---|
| transactionId | Unique Paytm transaction ID issued by Paytm for each transaction Example: 202xxxxxxxxxxxxxxx66 |
| orderId | Unique reference ID for a transaction generated by merchant Example: 20xxxxxxxx047 |
| merchantUniqueRef | Instrument specific Information : Link IDs, Subcription IDs, Invoice IDs Example: 28XXXXXXXXXXXXQB3G |
| transactionDate | Date of transaction Example: 2022-07-05T11:14:13+05:30 |
| updatedDate | Time when transaction details were updated Example: 2022-07-05T11:14:15+05:30 |
| transactionType | Types of transactions - ACQUIRING, REFUND, CHARGEBACK, REPAYMENT etc. Example: REFUND |
| status | Status of transaction - 'SUCCESS', 'PENDING', 'FAILURE' Example: SUCCESS |
| originalMid | Unique merchantID Example: HelloM8xxxxxxxx45 |
| merchantName | Name of the merchant Example: XXXXX limited |
| customerId | Customer ID of transaction Example: 53xxxxx54 |
| amount | Pre Unsettled Amount of each transaction Example: 1.00 |
| commission | Commission charged by PG on each transaction Example: 0.0 |
| gst | Service tax charged by PG on each transaction Example: 0.0 |
| merchantBillId | It is merchant POS order ID |
| payoutId | Unique ID generated at the time of payout Example: ALLxxxxxxxxxxxxxx11 |
| channel | Channel used for payment Example: AP_WAP |
| utrNo | Unique Reference Number of each transaction Example: 21xxxxxxxx104 |
| payoutDate | Date of payout generation Example: 2022-07-06T00:00:00+05:30 |
| settledDate | Date when settlement amount is transferred to merchant bank account Example: 2022-07-06T04:38:46+05:30 |
| paymentMode | Instruments of payment used by customers - UPI, Netbanking , Card etc Example: UPI |
| issuingBank | Issuer bank of customer Example: Unified Payment Interface |
| settledAmount |
Amount Settled to merchant bank account |
| bankTransactionId | Unique ID sent by the bank Example: 218xxxxxxxxx54 |
| referenceTransactionId | Reference Transaction ID |
| merchantRefId | Unique transaction identifier generated by merchant |
| prn | Payment Reference Number |
| acquiringFee | Acquiring fee charged by Paytm for each transaction Example: 0.0 |
| platformFee | Platform fee charged by Paytm for each transaction Example: 0.0 |
| acquiringTax | Tax charged by Paytm for each acquiring transaction Example: 0.0 |
| platformTax | Platform fee charged by Paytm for each transaction Example: 0.0 |
| ifscCode | IFSC Code of bank to which settlement amount is transferred |
| bankName | Name of the bank in which settlement is done ( Merchant bank ) |
| beneficiaryName | Beneficiary Name ( Merchant Name) |
| maskedCardNo | Card Number of customer in masked format |
| cardNetwork | Card Network of customer Example: MASTER |
| rrnCode | Refund Retrieval Number |
| disputeId | Unique ID incase of dispute transactions |
| posId | Unique ID of each edc machine |
| extSerialNo | Unique serial number of each edc Example: 20220xxxxxxxxxxxx368 |
| gateway | Gateway used for transaction Example: PPBEX |
| commissionRate | Commission Rate Charged by PG |
| productCode | Unique code of Product |
| requestType | Source used for payment. Example: UPI_QR_CODE |
| feeFactor | Fee Factor Example: solutionWiseMdr=API;Scheme=UPI;Bank=PPBLC; |
| van | Virtual Account Number |
Response Codes & Messages
| resultCode | resultStatus | resultMsg |
|---|---|---|
| 00000000 | S | success |
| 00000004 | F | parameter illegal |
| 00000900 | U | unknown system error |
| 12014163 | F | Platform internal id is not exist |
| 11012001 | F | dataservice system exception |
| 11012002 | F | result is empty while the business logic is violated. For example, when the REFUND order exists |
| 10010007 | F | No records found |
Staging
Production
This API is not hosted on staging environment.
REQUEST
RESPONSE
CURL
curl --location --request POST 'https://securegw.paytm.in/merchant-settlement/SettlementTransactionDetail ' \
--header 'Content-Type: application/json' \
--header 'clientId: xxxxxxxx' \
--header 'Authorization: Bearer xxxxxxxx' \
--data-raw '{
"request": {
"head": {
"reqMsgId": "9b688fce-c59f-4ead-9677-c38a43e3ab59"
},
"body": {
"mid": "HelloM8xxxxxxxx45",
"orderId": "20xxxxxxxxxxxx098",
"transactionDate":"2022-07-05"
}
}
}'
