v8
OpenAPI 3.1.02026-08-033623795.0 MBRefunds
List refunds
Returns a paginated list of refunds, with optional filtering by payment, company, user, and creation date.
Required permissions:
- payment:basic:read
get/refunds
Query parameters
afterstring nullable
Returns the elements in the list that come after the specified cursor.
beforestring nullable
Returns the elements in the list that come before the specified cursor.
firstinteger nullable
Returns the first n elements from the list.
Example:42
lastinteger nullable
Returns the last n elements from the list.
Example:42
payment_idstring nullable
Filter refunds to only those associated with this specific payment.
Example:pay_xxxxxxxxxxxxxx
company_idstring nullable
Filter refunds to only those belonging to this company.
Example:biz_xxxxxxxxxxxxxx
user_idstring nullable
Filter refunds to only those associated with this specific user.
Example:user_xxxxxxxxxxxxx
direction'asc' | 'desc'
The direction of the sort.
created_beforestring date-time nullable
Only return refunds created before this timestamp.
Example:2023-12-01T05:00:00.401Z
created_afterstring date-time nullable
Only return refunds created after this timestamp.
Example:2023-12-01T05:00:00.401Z
Response
A successful response
Example response
{
"data": [
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"id": "rf_xxxxxxxxxxxxxxx",
"payment": {
"id": "pay_xxxxxxxxxxxxxx"
},
"provider_created_at": "2023-12-01T05:00:00.401Z",
"reference_value": "74850120752"
}
]
}