Refund

This section of the Reach Pay API documentation details how to retrieve payment information using the Payment Details endpoint. It includes instructions on making a GET request with the required headers and provides information about the expected responses, including a successful retrieval of payment details or an error message if required headers are missing. This documentation is intended for developers integrating payment status checks into their applications.

Log in to see full request history
Body Params
string
required
Defaults to clientTest
float
required
Defaults to 100

This field specifies the amount to be refunded. It must be a integer value representing the portion of the original payment that the client wishes to refund. For instance, if the original payment was 100 SAR, specifying 50 as the amount will refund half of the payment.

string
required
Defaults to 394edd67-9532-4aaa-ae19-09b49a42be7e

This is the unique identifier for the payment transaction provided by the payment gateway. It is essential for locating the specific transaction that is to be refunded. Without this ID, the API will not be able to process the refund, as it won't know which transaction to apply it to.

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json