Payment Refund History
Payment Refund History
GET {{Environment_URL}}/v1/payments/refund/:paymentId/total
This endpoint allows you to retrieve the total refunded amount for a specific pay-in. Authentication is required, as well as the ID of the pay-in you want to check.
Headers
Name
Value
Authorization
Bearer <token>
Path Variables
Name
Description
paymentId
637
Response
{
"total": {
"amount": 0,
"currency": "BRL",
"precision": 0
},
"remaining": {
"amount": 507780,
"currency": "BRL",
"precision": 2
},
"history": []
}{
"total": {
"amount": 1000,
"currency": "BRL",
"precision": 2
},
"remaining": {
"amount": 0,
"currency": "BRL",
"precision": 2
},
"history": [
{
"id": "500680d4-60b2-42f8-adf4-4cfeb58525eb",
"amount": {
"amount": 250,
"currency": "BRL",
"precision": 2
},
"percentage": 25,
"status": "CREATED",
"createdAt": "2025-04-09T13:46:01.089Z"
},
{
"id": "4a6f6e6b-e799-4c2e-ad06-da388db0031c",
"amount": {
"amount": 250,
"currency": "BRL",
"precision": 2
},
"percentage": 25,
"status": "CREATED",
"createdAt": "2025-04-09T13:45:55.729Z"
},
{
"id": "4a89d8c5-f328-4ac0-b2a7-0cf546c53dca",
"amount": {
"amount": 500,
"currency": "BRL",
"precision": 2
},
"percentage": 50,
"status": "COMPLETED",
"createdAt": "2025-04-09T13:25:58.176Z"
}
]
}