The Read Chargeback API responds with the all the chargebacks corresponding to the merchant. The chargebacks are filtered out on the basis of dispute received date and pagination.
Request parameters
This must contain the header with token you get using the Get Token API in the following format:
\--header 'X-Optimus-API-Key: <Bearer token>'Query parameters
Parameter | Description | Example |
|---|---|---|
merchant_Id mandatory | This parameter must contain the PayU ID provided by PayU. | 143419 |
from_date | This parameter must contain the from date from when the charge back is required. | 20-02-2023 |
to_date | This parameter must contain the to date of charge back. | 21-02-2023 |
Sample request
Without date range
curl --location 'https://bankportal.payu.in/api/v1/chargebacks/16652223102' \
--header 'X-Optimus-API-Key: MerchantToken' \
--header 'Cookie: PHPSESSID=uq1sm7npk9dmid33bbe9dvdtcn'With date range
curl --location 'https://bankportal.payu.in/api/v1/chargebacks?from_date=20-02-2023&to_date=21-02-2023&merchant_id=143419' \
--header 'X-Optimus-API-Key: MerchantToken' \
--header 'Cookie: PHPSESSID=uq1sm7npk9dmid33bbe9dvdtcn'Response parameters
| Parameter | Description |
|---|---|
| id | This parameter contains the merchant ID. |
| type | The parameter contains the chargebacks as type. |
| attributes | This parameter contains the chargeback details in a JSON format. For more information, refer to attributes JSON field descriptions. |
attributes JSON field descriptions
Field | Description | |
|---|---|---|
id | The field contains the merchant ID. | 1295751 |
chargeback-amount | The field contains the chargeback amount. | 1.0 |
chargeback-type | The field contains the chargeback type. | CB |
status | The field contains the chargeback status. | Closed Customer Favour |
reply-before | The field contains the date before which the merchant must reply. | 24-Feb-2023 |
chargeback-reason | The field contains the chargeback reason. | Non Receipt of Goods or Services |
bank-case-no | The field contains the bank case number for the chargeback. | 30008130343023154997151 |
debit-date | The field contains the chargeback debit date. | 24-Jul-2023 |
debit-status | The field contains the chargeback debit status. | Chargeback Debited |
credit-date | The field contains the chargeback credit date. | |
customer-dispute-docs | The field contains the location of the docs or additional information provided to bank support about the disputed transaction. | |
transaction-details | This field contains the transaction details in a JSON format. | { |
Sample response
Without date range
{
"data": {
"id": "1295751",
"type": "chargebacks",
"attributes": {
"id": 1295751,
"chargeback-amount": "1.0",
"chargeback-type": "CB",
"chargeback-date": "20-Feb-2023",
"status": "Closed Customer Favour",
"reply-before": "24-Feb-2023",
"chargeback-reason": "Non Receipt of Goods or Services",
"bank-case-no": "30008130343023154997151",
"debit-date": "24-Jul-2023",
"comments": null,
"debit-status": "Chargeback Debited",
"credit-date": "NA",
"customer-dispute-docs": [],
"transaction-details": {
"payu-id": "16652223102",
"transaction-id": "c0bb0c2107f53e791cb4",
"transaction-date": "23-Jan-2023",
"transaction-amount": "1.0",
"pg-name": "HPYIndusInd",
"card-number": "XXXXXXXXXXXX7559",
"refunded": false,
"refund-amount": null,
"bank-reference-number": "302315499715",
"settlement-date": "NA",
"merchant-utr": null,
"product-info": "Product Info",
"additional-charges": "0.0",
"transaction-fee": "1.0",
"udf-1": "",
"udf-5": null,
"card-scheme": null
},
"customer-details": {
"first-name": "Payu-Admin",
"last-name": "",
"email": "[email protected]",
"phone-number": "1234567890"
}
}
}
}With date range
{
"data": [
{
"id": "1295751",
"type": "chargebacks",
"attributes": {
"id": 1295751,
"chargeback-amount": "1.0",
"chargeback-type": "CB",
"chargeback-date": "20-Feb-2023",
"status": "Closed Customer Favour",
"reply-before": "24-Feb-2023",
"chargeback-reason": "Non Receipt of Goods or Services",
"bank-case-no": "30008130343023154997151",
"debit-date": "24-Jul-2023",
"comments": null,
"debit-status": "Chargeback Debited",
"credit-date": "NA",
"customer-dispute-docs": [],
"transaction-details": {
"payu-id": "16652223102",
"transaction-id": "c0bb0c2107f53e791cb4",
"transaction-date": "23-Jan-2023",
"transaction-amount": "1.0",
"pg-name": "HPYIndusInd",
"card-number": "XXXXXXXXXXXX7559",
"refunded": false,
"refund-amount": null,
"bank-reference-number": "302315499715",
"settlement-date": "NA",
"merchant-utr": null,
"product-info": "Product Info",
"additional-charges": "0.0",
"transaction-fee": "1.0",
"udf-1": "",
"udf-5": null,
"card-scheme": null
},
"customer-details": {
"first-name": "Payu-Admin",
"last-name": "",
"email": "[email protected]",
"phone-number": "1234567890"
}
}
},
{
"id": "1295752",
"type": "chargebacks",
"attributes": {
"id": 1295752,
"chargeback-amount": "1.0",
"chargeback-type": "CB",
"chargeback-date": "20-Feb-2023",
"status": "Closed Customer Favour",
"reply-before": "24-Feb-2023",
"chargeback-reason": "Non Receipt of Goods or Services",
"bank-case-no": "30008130343023159959693",
"debit-date": "24-Jul-2023",
"comments": null,
"debit-status": "Chargeback Debited",
"credit-date": "NA",
"customer-dispute-docs": [],
"transaction-details": {
"payu-id": "16652143419",
"transaction-id": "0d344315b040a777f30a",
"transaction-date": "23-Jan-2023",
"transaction-amount": "1.0",
"pg-name": "HPYIndusInd",
"card-number": "XXXXXXXXXXXX7559",
"refunded": false,
"refund-amount": null,
"bank-reference-number": "302315995969",
"settlement-date": "NA",
"merchant-utr": null,
"product-info": "Product Info",
"additional-charges": "0.0",
"transaction-fee": "1.0",
"udf-1": "",
"udf-5": null,
"card-scheme": null
},
"customer-details": {
"first-name": "Payu-Admin",
"last-name": "",
"email": "[email protected]",
"phone-number": "1234567890"
}
}
},
{
"id": "1295753",
"type": "chargebacks",
"attributes": {
"id": 1295753,
"chargeback-amount": "1.0",
"chargeback-type": "CB",
"chargeback-date": "20-Feb-2023",
"status": "Closed Customer Favour",
"reply-before": "24-Feb-2023",
"chargeback-reason": "Non Receipt of Goods or Services",
"bank-case-no": "30008130343019172078172",
"debit-date": "24-Jul-2023",
"comments": null,
"debit-status": "Chargeback Debited",
"credit-date": "NA",
"customer-dispute-docs": [],
"transaction-details": {
"payu-id": "16626771711",
"transaction-id": "f73f8ee2567488b03269",
"transaction-date": "19-Jan-2023",
"transaction-amount": "1.0",
"pg-name": "HPYIndusInd",
"card-number": "XXXXXXXXXXXX7559",
"refunded": false,
"refund-amount": null,
"bank-reference-number": "301917207817",
"settlement-date": "NA",
"merchant-utr": null,
"product-info": "Product Info",
"additional-charges": "0.0",
"transaction-fee": "1.0",
"udf-1": "",
"udf-5": null,
"card-scheme": null
},
"customer-details": {
"first-name": "Payu-Admin",
"last-name": "",
"email": "[email protected]",
"phone-number": "1234567890"
}
}
}
],
"meta": {
"pagination": {
"per-page": 500,
"total-chargebacks": 3,
"total-pages": 1
}
}
}