Skip to main content
GET
/
refund-chargeback
/
refund
/
merchant
/
api
/
refund_history?from=
{from}
&to=
{to}
&currency=
{currency}
&page=
{page}
&size=
{size}
&refund_status=
{refund_status}
Fetch Refund History
curl --request GET \
  --url 'https://api.payaza.africa/live/refund-chargeback/refund/merchant/api/refund_history?from={from}&to={to}&currency={currency}&page={page}&size={size}&refund_status={refund_status}' \
  --header 'Authorization: <api-key>'
{
  "status": "success",
  "message": "Refund History Success.",
  "data": {
    "content": [
      {
        "id": 28824,
        "refund_amount": 0.05,
        "transaction_amount": 0.05,
        "transaction_fee": 0,
        "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",
        "transaction": {
          "id": 20149381,
          "description": "Test for Headers",
          "ended_at": "2024-08-05 12:03:13.777000",
          "fee_amount": 0,
          "rrn": "000812310925",
          "collection_channel": "Card",
          "started_at": "2024-08-05 12:03:13.777000",
          "status_reason": "Payment Approved",
          "transaction_amount": 0.05,
          "transaction_reference": "QA-PL-1KBPSCJCRD947",
          "transaction_status": "Completed",
          "customer": {
            "id": 29425269,
            "email_address": "johndoe@gmail.com",
            "first_name": "John",
            "last_name": "Doe",
            "mobile_number": "08123456789"
          },
          "currency": {
            "id": 2,
            "name": "US Dollar",
            "code": "USD",
            "html_code": "&#36;",
            "iso_code": "USA",
            "unicode": "$",
            "active": true
          }
        },
        "status_reason": "Refund processed successfully",
        "merchant_name": "Integration"
      }
    ],
    "total": 1,
    "last": false,
    "first": true,
    "pageable": {
      "page": 1,
      "size": 10
    }
  }
}

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

Path Parameters

from
string

The unique identifier given to a particular transaction

to
string

The unique identifier given to a particular transaction

currency
string

The unique identifier given to a particular transaction

page
string
required

The unique identifier given to a particular transaction

size
string
required

The unique identifier given to a particular transaction

refund_status
string
required

The unique identifier given to a particular transaction

Response

Fetch Refund History Response

status
string

API status (e.g., success).

Example:

"success"

message
string

Status message.

Example:

"Refund History Success."

data
object