API Reference
Start typing to search…

Settlement Reconciliation API

This API reconciles the settlements for a given parent mid and specified period (date range).

HTTP Method: POST

Environment

Test Environment<https://test.payu.in/merchant/>
Production Environment<https://info.payu.in/merchant/>

Request parameters

Parameter Description Example

Merchant key
mandatory

varchar The merchant key is included in this parameter.

Your Test Key

command
mandatory

varchar The API command name get_settlement_details_range must be included in this parameter.

get_settlement_details_range

hash
mandatory

varchar The hash string encryption is specified in this parameter. The format of the hash is:
string key|command|var1|salt Where var1 is the date is the date range.

string tXjTgO

var1: datefrom
mandatory

varchar The parameter contains the date on which the range starts or particular date.

2022-08-22

var2: dateTo
optional

varchar The parameter contains the end date until which the statement is required.

2022-08-25

var3: aggregator
optional

boolean This parameter can contain any of the following values:

  • true: It will return the information of the children as well.
  • false: It will return the information of the parent only.

true

var4: page
optional

integerThis parameter can include the page number that is used if the API returns several pages as a result

2

Sample request

curl -X POST "https://info.payu.in/merchant/postservice?form=2"
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d
"key=JP***g&command=get_settlement_details_range&var1=2022-07-23&hash=259ded5457ad8d078b3c06294413680d0b9eb341682a4f0eecad17256388c2e096f37f5077480e3a56000cc0a3585f7cd73a7d2d10d8225a05b3b93cd27fd5f8var2=2021-08-12"

Response parameters

Field Description Example

rows

The number of rows returned.

2

message

The summary of the response that includes the number of settlements and date of them.

2 Settlements found for the 2022-07-23T00:00 and 2022-07-26T23:59:59.999999999

status

This response can contain any of the following:

  • 1 if API call is a success
  • 0 in case of failure you'll get system handled failure reasons in this case

1

result

This parameter contains the settlements in a JSON format. For detailed information, refer to result JSON Fields Description.

Refer to Sample Response

guid

This parameter contains the geographically unique ID of the transaction.

sessionId

This parameter contains the session ID of the transaction

errorCode

This parameter contains the error code if the transaction had failed. The error can be any of the following: | Please pass valid merchant key

result JSON fields description

The result parameter contains the following fields in a JSON format:

FieldDescriptionExample
settlementIdThis field contains the settlement ID8599910202207241245
settlementCompletedDateThis field contains the settlement completion date and time.2022-07-23 17:35:06
settlementAmountThis field contains the settlement amount to the child merchant.122185.00
merchantIdThis field contains the child merchant ID.8599910
utrNumberThis field contains the merchant Unique Transaction Reference (UTR) number.ijklmn
transactionThis field contains the transaction details in a JSON format. For more information, refer to transaction JSON Fields Description.Refer to Sample Response
utrnumberThis field contains the unique transaction number of the transaction.123456

transaction JSON fields description

The transaction field contains the following fields in a JSON format:

Field Description Example

action

This field contains the purpose of the transaction. This field can contain any of the following values:

  • Capture
  • Adjustment_credit
  • Adjustment_debit
  • Refund
  • Failed

Adjustment_credit

payuId

This field contains the PayU ID of the child merchant.

ADJ122538

transactionAmount

This field contains the transaction amount that needs to be settled.

6942.00

merchantServiceFee

This field contains the merchant service fee.

8.0000

merchantServiceTax

This field contains merchant service tax.

8.0000

merchantNetAmount

This field contains the net amount settled to the merchant.

 

cgst

This field contains the CGST amount part of the transaction.

 

igst

This field contains the IGST amount pat of the transation

 

transactionsgst

This field contains the SGST part of the transaction

 

merchantTransactionId

This field contains the merchant transaction ID

ADJ122538

For Adjustment Status Transactions

adjustmentType

This field contains the adjustment type

credit

referenceId

This field contains the reference ID.

1

blockType

This field contains the block type.

 

adjustmentAction

 

TDR Adjustment

For Adjustment Credit Status Transactions

mode

This field contains the payment mode for the tranaction.

credit

cardType

This field contains the card type used for the transaction.

 

paymentStatus

This field contains the payment status to the child merchant.

inProgress

transactionDate

This field contains the transaction date and time.

2022-07-23 01:45:43

requestedAmount

This field contains the amount requested by the child merchant.

6942.00

requestDate

This field contains the date when the child merchant requested the amount.

2022-07-23 01:45:43

bankName

This field contains the bank involved in card, Net Banking or UPI transaction.

 

token

This field contains the card token if the card is tokenised.

 

For Refund Status Transactions

paymentId

This field contains the payment ID of the transaction.

58871981

refundStatus

This field contains the refund status

refundinprogress

paymentAddedOn

This field contains the date when the payment was added on.

2017-12-08

paymentAmount

This field contains the payment amount.

200.00

saleAmount

This field contains the original sale amount.

200.00

Sample response

{
  "rows": 2,
  "message": "2 Settlements found for the 2022-07-23T00:00 and 2022-07-26T23:59:59.999999999",
  "status": 1,
  "result": [
    {
      "settlementId": "8599910202207241245",
      "settlementCompletedDate": "2022-07-23 17:35:06",
      "settlementAmount": "122185.00",
      "merchantId": 8599910,
      "utrNumber": "ijklmn",
      "transaction": [
        {
          "action": "Adjustment_credit",
          "payuId": "ADJ122538",
          "transactionAmount": "6942.00",
          "merchantNetAmount": "",
          "cgst": "",
          "igst": "",
          "sgst": "",
          "merchantTransactionId": "ADJ122538",
          "mode": "credit",
          "cardType": "",
          "paymentStatus": "inProgress",
          "transactionDate": "2022-07-23 01:45:43",
          "requestedAmount": "6942.00",
          "requestDate": "2022-07-23 01:45:43",
          "bankName": "",
          "token": ""
        }
      ]
    },
    {
      "settlementId": "8597923202207251245",
      "settlementCompletedDate": "2022-07-23 17:40:06",
      "settlementAmount": "18.88",
      "merchantId": 8593059,
      "utrNumber": "abcdef",
      "transaction": [
        {
          "action": "capture",
          "payuId": "15553396797",
          "parentPayuId": "15553211345",
          "requestId": "10801247706",
          "transactionAmount": "4.72",
          "merchantServiceFee": "8.0000",
          "merchantServiceTax": "8.0000",
          "merchantNetAmount": "4.7200",
          "cgst": "0.00000",
          "igst": "1.44000",
          "sgst": "0.00000",
          "merchantTransactionId": "216245453",
          "paymentStatus": "captured",
          "transactionDate": "2022-07-23 10:15:43",
          "requestedAmount": "14.16",
          "requestDate": "2022-07-23 10:15:38",
          "bankName": "IDBB"
        },
        {
          "action": "capture",
          "payuId": "15553398000",
          "parentPayuId": "15553287497",
          "requestId": "10801248633",
          "transactionAmount": "4.72",
          "merchantServiceFee": "8.0000",
          "merchantServiceTax": "8.0000",
          "merchantNetAmount": "4.7200",
          "cgst": "0.00000",
          "igst": "1.44000",
          "sgst": "0.00000",
          "merchantTransactionId": "216249103",
          "paymentStatus": "captured",
          "transactionDate": "2022-07-23 10:15:53",
          "requestedAmount": "14.16",
          "requestDate": "2022-07-23 10:15:48",
          "bankName": "BOIB"
        }
      ]
    }
  ]
}