Retrieves a paginated list of refunds. You can filter the results using various query parameters.
Query Parameters
Filter refunds created after this date (ISO 8601 format, e.g., 2023-01-01T00:00:00.000Z)
Filter refunds created before this date (ISO 8601 format, e.g., 2023-01-01T12:00:00.000Z)
Filter by refund status. Possible values: created, pending, pending_manual, successful, failed
Filter by transfer reference (original transfer reference)
Page number for pagination
Number of results per page (max 100)
Response
Array of refund objects
The current status of the refund
The original transfer ID that is being refunded
The currency of the refund
The reason for the refund
The payment method used for the refund
Whether fallback methods are allowed
Whether a fallback method was used
Additional metadata associated with the refund
The Zendesk ticket ID associated with the refund
The date and time when the refund was created
The date and time when the refund was last updated
Pagination information
Number of results per page
curl --location --request GET 'https://api.hub2.io/refunds?fromDate=2023-01-01T00:00:00.000&toDate=2023-01-01T12:00:00.000&page=1&perPage=100' \
--header 'ApiKey: [REDACTED]' \
--header 'MerchantId: [REDACTED]' \
--header 'Environment: sandbox' \
--header 'Content-Type: application/json'
{
"data": [
{
"id": 123,
"status": "successful",
"transactionId": "tr_000000000000000000011",
"amount": 2000,
"currency": "XOF",
"reason": "Customer requested refund",
"paymentMethod": "mobile_money",
"fallbackAllowed": true,
"fallbackUsed": false,
"metadata": {},
"zendeskTicketId": "zd_123456",
"createdAt": "2023-01-01T12:00:00.000Z",
"updatedAt": "2023-01-01T12:30:00.000Z"
},
{
"id": 124,
"status": "pending",
"transactionId": "tr_000000000000000000012",
"amount": 1500,
"currency": "XOF",
"reason": "Merchant initiated refund",
"paymentMethod": "mobile_money",
"fallbackAllowed": true,
"fallbackUsed": false,
"metadata": {},
"zendeskTicketId": "zd_789012",
"createdAt": "2023-01-01T11:30:00.000Z",
"updatedAt": "2023-01-01T11:30:00.000Z"
}
],
"pagination": {
"page": 1,
"perPage": 100,
"total": 2,
"totalPages": 1
}
}
