Check Refund Status - Payaza Documentation

curl --request POST \ --url https://api.payaza.africa/live/card/card_charge/refund_status \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "service_payload": { "refund_transaction_reference": "RF20231112-Q232USD" } } '

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

Authorizations

Authorization

string

header

required

Payaza {{Public API Key in Base 64}}

Body

application/json

service_payload

object

required

It contains the details of the service payload.

Show child attributes

Response

Check Transaction Status Response

statusOk

boolean

Indicates if the request was successful.

Example:

true

message

string

Response message.

Example:

"Request Completed"

transactionReference

string

The reference of the original transaction being refunded.

Example:

"T3737157"

refundReference

string

Unique reference for this refund request.

Example:

"RF20231112-Q232USD"

refundStatus

string

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

Example:

"SUCCESS"

statusReason

string

Detailed reason for the status.

Example:

"Refund processed successfully"

refundDate

string<date-time>

Timestamp when the refund was processed.

Example:

"2023-11-12T23:30:06.688465"

refundedAmount

number<double>

The amount that was refunded.

Example:

5.2

parentTransactionAmount

number<double>

The total amount of the original transaction.

Example:

5.2