Request Payment

This documentation provides detailed information about the Reach Pay API, focusing on the checkout process. It covers the API endpoint, request and response structures, field definitions, and potential error messages. This guide is intended for developers integrating the Reach Pay service into their applications, ensuring seamless payment processing and accurate transaction tracking.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to clientTest

Unique identifier for the client. This ID is used to associate the transaction with a specific client in the system.

string
Defaults to 3ac-4d6e-4230-9b9c-6cd01b96350d

The identifier for the location where the transaction is taking place. This field is crucial for multi-location clients to track transactions accurately.

string
required
Defaults to ca73caca711111113s1a13ca71111121

A unique identifier for the order associated with the payment. This ID is used to link the payment to the correct order.

string
required
Defaults to ca7111111a59

A unique identifier for the payment transaction. This field ensures that each payment is uniquely tracked and managed.

float
required
Defaults to 33

The total amount to be paid. This field should include the currency in the relevant context (e.g., SAR))

string
required
Defaults to https://webhook.site/d8420c66-d8c0-49ea-b858-fa29dfafba9b

This field will activate the webhook, regardless of whether the payment is successful or fails.

string
Defaults to token_R5BHVKrftwbnaVmw95hxZjMjJZ

A token representing the customer's card information, used for processing the payment. This field is optional, depending on whether the payment is made using a stored card.

string
Defaults to https://www.reachware.com

The URL of the customer's webpage to which the redirection will occur upon completion of the operation. If the key is not supplied, the redirection will default to the Reachpay results page.

string
Defaults to en
string
Defaults to false
Responses

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