paytm developer docs logoDeveloperDocumentation
search

POSTSettlement Detail API

Use Case

Settlement Detail API retrieves detailed/transactional view of all the settled transactions at payout level based on date range or payout ID. It includes all types of transactions namely, forward or acquiring transactions, refunds and chargebacks. Merchants can reconcile from wide list of output parameters including customer details, merchant bank details etc.

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

Payout Level Based on Payout Date

ATTRIBUTE DESCRIPTION
mid
mandatory		 Unique merchantId
Example. HelloM8xxxxxxxx45
startDate
mandatory		 Date from which merchant wants to check the settlement data.
Example. 2022-07-06
endDate

Date upto which merchant wants to check the settlement data

Note: Maximum Date Range supported is 1 week
Example. 2022-07-06
pageNum Current page number
Example. 1
pageSize the size of one page
Note : Maximum Page Size is 20
Example. 20

Payout Level Based on Payout ID

mid
mandatory		 Unique merchantId
Example. HelloM8xxxxxxxx45
payoutId
mandatory		 Payout ID for the bank transfer made.
Example. ALL2xxxxxxxxxxxxxxx911
pageNum Current page number
Example. 1
pageSize the size of one page
Note : Maximum Page Size is 20
Example. 20

 

 

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:26:17+05:30

Body

ATTRIBUTE DESCRIPTION
mid Unique merchantID
Example: HelloM8xxxxxxxx45
payoutId Unique ID generated at the time of payout
Example: ALL2xxxxxxxxxxxxxxx911
transactionId Unique Paytm transaction ID issued by Paytm for each transaction
Example: 2022xxxxxxxxxxxxxxxx95
orderId Unique reference ID for a transaction generated by merchant
Example: 202xxxxxxxxxx098
merchantUniqueRef Instrument specific Information : Link IDs, Subcription IDs, Invoice IDs
Example: 28XXXXXXXXXXQB3G
transactionDate Date of transaction
Example: 2022-07-05T11:11:43+05:30
updatedDate Time when transaction details were updated
Example: 2022-07-05T11:11:44+05:30
transactionType Types of transactions - ACQUIRING, REFUND, CHARGEBACK, REPAYMENT etc.
Example: ACQUIRING
status Status of transaction - 'SUCCESS', 'PENDING', 'FAILURE'
Example: SUCCESS
merchantName Name of the merchant
Example:  XXXX Limited
customerId Customer ID of transaction
Example: 53xxxxx4
nickName Customer Name
Example: XXXXXX
customerPhoneNo Customer phone number
Example: 90****4041
customerEmailId Customer email ID
Example: vijay*********@gmail.com
amount Pre Unsettled Amount of each transaction
Example: 2.00
commission Commission charged by PG on each transaction
Example: 0.0
gst Service tax charged by PG on each transaction
Example: 0.0
settledAmount Amount Settled to merchant bank account
Example: 2.00
channel Channel used for payment
Example: AP_WAP
utrNo Unique Reference Number of each transaction
Example: 21xxxxxxxx04
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 
Example: UPI, BALANCE
issuingBank Issuer bank of customer
Example: XXXX Bank
merchantBillId It is merchant POS order ID
bankTransactionId Unique ID sent by the bank
Example: 20xxxxxxxx66
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: 2022xxxxxxxxxxxxxx68
gateway Gateway used for transaction
Example: PPBXXX
commissionRate Commission Rate Charged by PG
productCode Unique code of Product
requestType Source used for payment.
Example: NATIVE etc.
feeFactor Fee Factor
Example: solutionWiseMdr=API;Scheme=UPI;
Bank=PPBLC;
van Virtual Account Number

 

Response Codes & Messages

resultCoderesultStatusresultMsg
00000000Ssuccess
00000004Fparameter illegal
00000900Uunknown system error
12014163FPlatform internal id is not exist
00000019FProcess fail
12014162FSupport max query time is 180 days
10010007FNo records found
⇾
Staging
Production
This API is not hosted on staging environment.copy icon
REQUEST
RESPONSE
CURL
CURL
curl --location --request POST 'https://secure.paytmpayments.com/merchant-settlement/SettlementDetail' \
--header 'Content-Type: application/json' \
--header 'clientId: 73xxxxxxxxxxxxxxx64' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxx' \
--data-raw '{
    "request": {
        "head": {
            "reqMsgId": "9b688fce-c59f-4ead-9677-c38a43e3ab59"
        },
        "body": {
            "mid":"HelloM8xxxxxxxx45",
            "startDate":"2022-07-06"
        }
    }
}'



 
copy icon