- Signature: XXX
- Accept: application/json
- Content-type: application/json
Body Parameters
Parameter |
Description |
Type |
When present |
type |
Notification type — only REFUND |
string |
Always |
version |
Notification version |
string |
Always |
refund |
Refund description |
object |
Always |
refund
Parameter |
Description |
Type |
When present |
type |
Operation type — only REFUND |
string(200) |
Always |
paymentId |
Payment identifier in the merchant’s system |
string(200) |
Always |
refundId |
Refund identifier in the merchant’s system |
string(200) |
Always |
createdDateTime |
Operation date and time |
URL-encoded stringYYYY-MM-DDThh:mm:ssZ |
Always |
amount |
Operation amount |
object |
Always |
billId |
Identifier of the invoice corresponding to the operation |
string(200) |
Always |
status |
Operation status |
object |
Always |
paymentMethod |
Payment method |
object |
Always |
merchantSiteUid |
Merchant’s site identifier |
string |
Always |
customer |
Customer information |
object |
Always |
customFields |
Additional information that supplements the operation data |
object |
Always |
flags |
Additional API commands |
Array. Possible elements: SALE , REVERSAL |
Always |
settlementAmount |
Merchant’s settlement amount |
object |
If payment currency and merchant settlement currency are different |
amount
Parameter |
Description |
Type |
When present |
value |
Operation amount, rounded down to two decimal places |
Number(6.2) |
Always |
currency |
Currency code according to ISO 4217 |
string(3) |
Always |
status
Parameter |
Description |
Type |
When present |
value |
Notification status |
string |
Always |
changedDateTime |
Notification status change date and time |
URL-encoded stringYYYY-MM-DDThh:mm:ssZ |
Always |
reasonCode |
Rejection reason code |
string(200) |
If the operation was rejected |
reasonMessage |
Rejection reason description |
string(200) |
If the operation was rejected |
errorCode |
Error code |
Number |
In case of errors |
paymentMethod
Parameter |
Description |
Type |
When present |
type |
Payment method type |
string |
Always |
paymentToken |
Payment token |
string |
For payments using a payment token |
maskedPan |
Masked PAN |
string |
For payments using a payment token or card |
rrn |
Payment RRN (ISO 8583) |
number |
For payments using a payment token or card |
authCode |
Auth-code for the payment |
number |
For payments using a payment token or card |
customer
Parameter |
Description |
Type |
When present |
phone |
Customer’s phone |
string |
Always |
email |
Customer’s e-mail |
string |
Always |
account |
Customer’s identifier in the merchant’s system |
string |
Always |
ip |
Customer’s IP address |
string |
Always |
country |
Customer’s country from address string |
string |
Always |
bic |
BIC of the bank that issues the card |
string |
Only for FPS payments |
lastName |
Customer’s last name |
string |
Only for FPS payments |
firstName |
Customer’s name |
string |
Only for FPS payments |
middleName |
Customer’s patronymic |
string |
Only for FPS payments |
simpleAddress |
Customer’s address |
string |
Only for FPS payments |
inn |
Customer’s TIN |
string |
Only for FPS payments |
bankMemberId |
Customer’s bank identifier |
string |
Only for FPS payments |
customFields
Parameter |
Description |
Type |
When present |
cf1 |
Additional information that supplements the operation data |
string(256) |
Always |
cf2 |
Additional information that supplements the operation data |
string(256) |
Always |
cf3 |
Additional information that supplements the operation data |
string(256) |
Always |
cf4 |
Additional information that supplements the operation data |
string(256) |
Always |
cf5 |
Additional information that supplements the operation data |
string(256) |
Always |
settlementAmount
Parameter |
Description |
Type |
When present |
value |
Settlement amount, rounded down to two decimal places |
number(6.2) |
If payment currency and merchant settlement currency are different |
currency |
Currency code according to ISO 4217 |
string(3) |
If payment currency and merchant settlement currency are different |
Notification Body Example
REFUND notification body example{
"refund": {
"refundId": "4ad8c332-f4ab-426c-baac-f1a2e0f16nvuth»,
"createdDateTime": "2025-07-08T10:12:42+03:00",
"status": {
"value": "SUCCESS",
"changedDateTime": "2025-07-08T10:12:42+03:00"
},
"amount": {
"value": 2.00,
"currency": "RUB"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "220220******1111»,
"cardHolder": null,
"cardExpireDate": "6/2027"
},
"merchantSiteUid": "test-01",
"customer": {
"phone": "0"
},
"gatewayData": {
"type": "ACQUIRING"
},
"billId": "autogenerated-fd319d87-162c-4da6-86c2-f67320f1832c",
"flags": [],
"refundSplits": [],
"paymentId": "aabbddd0-5ae1-41b9-888f-a25ea961f48b",
"type": "REFUND"
},
"type": "REFUND",
"version": "1"
}