Sign in

v1

latestOpenAPI 3.0.12026-07-225791279.7 KB
Card Collection

Check Refund Status

This endpoint is used to fetch the status of a refunded card payment (transaction).

post/card/card_charge/refund_status

Request body

Example request

{
  "service_payload": {
    "refund_transaction_reference": "RF20231112-Q232USD"
  }
}

Response

Check Transaction Status Response

statusOkboolean

Indicates if the request was successful.

messagestring

Response message.

transactionReferencestring

The reference of the original transaction being refunded.

refundReferencestring

Unique reference for this refund request.

refundStatusstring

Status of the refund (e.g., SUCCESS).

statusReasonstring

Detailed reason for the status.

refundDatestring date-time

Timestamp when the refund was processed.

refundedAmountnumber double

The amount that was refunded.

parentTransactionAmountnumber double

The total amount of the original transaction.

Example response

{
  "statusOk": true,
  "message": "Request Completed",
  "transactionReference": "T3737157",
  "refundReference": "RF20231112-Q232USD",
  "refundStatus": "SUCCESS",
  "statusReason": "Refund processed successfully",
  "refundDate": "2023-11-12T23:30:06.688465",
  "refundedAmount": 5.2,
  "parentTransactionAmount": 5.2
}