v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

List all Refunds

This API lets you view all refunds associated with your business

get/collections/refund?

Query parameters

businessstring

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Refunds fetched successfully",
  "data": {
    "results": [
      {
        "id": 21,
        "collectionReference": "96d1fc1c-2570-4a50-8eca-1277c4a90c0d",
        "reference": "cba44033-bcaa-4df6-9e68-6b3cf7f251ca",
        "currency": "NGN",
        "amountRefunded": "5914.000000",
        "refundType": "overpayment",
        "payeeAccountNumber": "7821444125",
        "collectionAmountReceived": "6764.000000",
        "collectionVarianceType": "overpayment",
        "refundStatus": "processing",
        "completedAt": "2023-12-07 17:39:00",
        "initiatedAt": "2023-12-05 15:07:18"
      }
    ],
    "total": 1
  }
}