Retrieving Information on All Payment Reversals and Refunds¶
Gets statuses for all refunds of the payment.
For additional information, please see “Payment Reversal and Refund“
Request¶
GET /payin/v1/sites/{siteId}/payments/{paymentId}/refunds
Path Parameters¶
Parameter | Required | Type | Description |
---|---|---|---|
siteId | Yes | string | Merchant site identifier |
paymentId | Yes | string | Payment identifier. The merchant receives this identifier in the payment notification |
Headers¶
Header | Required | Type | Description |
---|---|---|---|
Authorization | Yes | string | API access key. Bearer [access-token] |
Content-type | Yes | string | Request content. application/json |
Accept | No | string | Response content. application/json |
Request Example¶
Refund status
GET /partner/payin/v1/sites/test-01/payments/1811/refunds HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com
Response¶
See also HTTP error codes
Successful Response Parameters¶
Parameter | Required | Type | Description |
---|---|---|---|
refundId | Yes | string | Unique refund identifier in the merchant’s system. Same as in the request |
createdDateTime | Yes | string | Operation date and time |
amount | Yes | object | Operation amount |
status | Yes | object | Operation status |
flags | No | string(256) | Additional API commands.REVERSAL — card reversal operation was used for bank card operation |
settlementAmount | No | object | Merchant’s settlement amount (when settlement currency differs from the currency of the payment authorization) |
Error Parameters¶
Parameter | Required | Type | Description |
---|---|---|---|
serviceName | Yes | string | Name of the service that produced the error |
errorCode | Yes | string | Error code |
description | Yes | string | Error description for the merchant |
userMessage | Yes | string | Error description for the customer |
dateTime | Yes | string | Error date and time |
traceId | Yes | string | Error Log unique ID |
cause | No | object | Description for the field validation error |
Response Examples¶
[
{
"refundId": "e07ddaac-fbe0-4f01-a6f6-c36131fb90e3",
"createdDateTime": "2025-06-19T14:55:01+03:00",
"amount": {
"currency": "RUB",
"value": "4.00"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2025-06-19T14:55:01+03:00"
}
},
{
"refundId": "4889c0c6-700e-483f-b878-bb07617d6912",
"createdDateTime": "2025-06-19T14:55:11+03:00",
"amount": {
"currency": "RUB",
"value": "2.00"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2025-06-19T14:55:11+03:00"
}
}
]