v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Refunds And Chargebacks

Fetch Refund History

The merchant uses this endpoint to fetch refund transaction history for card transactions. The data output can be filtered using a date range and/or status..

get/refund-chargeback/refund/merchant/api/refund_history?from={from}&to={to}&currency={currency}&page={page}&size={size}&refund_status={refund_status}&refund_reference={refund_reference}

Path parameters

fromstring

The start date range to filter data in YYYY-MM-DD format

tostring

The end date range to filter data in YYYY-MM-DD format

currencystring

The <b>ISO 4217 alpha-3</b> currency code. e.g. NGN, USD

pageinteger required

The page number

sizeinteger required

The total number of transactions per page.

refund_statusstring required

“Success” or “Initialized”

refund_referencestring

The refund reference

Response

Fetch Refund History Response

statusstring

API status (e.g., success).

messagestring

Status message.

Example response

{
  "status": "success",
  "message": "Refund History Success.",
  "data": {
    "content": [
      {
        "id": 28824,
        "refund_amount": 0.05,
        "transaction_amount": 0.05,
        "transaction_reference": "RF20230228-PS56JY26JYJ0USD",
        "mpgs_refund_type": "REFUNDED",
        "mpgs_refund_status": "SUCCESS",
        "refund_order_id": "QA-PL-1KBPSCJCRD947",
        "refund_transaction_id": "RF20230228-LDUUSD",
        "start_at": "2024-08-06 12:44:48.652847",
        "end_at": "2024-08-06 12:44:50.408276",
        "status_reason": "Refund processed successfully",
        "merchant_name": "Integration"
      }
    ],
    "total": 1
  }
}