This endpoint allows you to query the current status of a previously initiated payment transaction.

Endpoint

POST

Header Parameters

Content-Type string (Required)

Indicates the format of the data that has to be sent or received.

Example: application/json

x-api-name string (Required)

This is for authentication purpose and can be obtained by logging into the Extranet itself.

Example: XXXXFIRSTAPP

x-api-key string (Required)

This is for authentication purpose and can be obtained by logging into the Extranet itself.

Example: kfpwsfnknknfwknfkwnknef9823rujfsormDFS3ijoncvowoeorfnv

partner_id string (Required)

Indicates the unique property ID assigned upon the creation of the property.

transaction_id string (Required)

The transaction ID that was previously generated during the payment request. This ID is used to query the current status of the transaction.

Sample Request

Responses

200 Success Response

Status string

The status of the request. "Success" indicates the request was successfully processed.

ErrorMessagesarray

An array of error messages. If there were no errors, this will be an empty array.

transaction_details object

Contains details about the transaction status.

pg_transection_id string

The unique transaction ID assigned by the payment gateway.

amount string

The amount of the transaction.

currency string

The currency of the transaction.

status string

The status of the transaction. A status of "Success" indicates the payment was completed successfully.

Error Response

status string

Indicates the status of the request.

ErrorMessages string

Indicates the error messages, if any.

This endpoint is designed to facilitate the generation of a secure payment link for a customer to complete a credit card transaction.

Endpoint

POST

Header Parameters

Content-Type string (Required)

Indicates the format of the data that has to be sent or received.

Example: application/json

x-api-name string (Required)

This is for authentication purpose and can be obtained by logging into the Extranet itself.

Example: XXXXFIRSTAPP

x-api-key string (Required)

This is for authentication purpose and can be obtained by logging into the Extranet itself.

Example: kfpwsfnknknfwknfkwnknef9823rujfsormDFS3ijoncvowoeorfnv

partner_id string (Required)

Indicates the unique property ID assigned upon the creation of the property.

amount string (Required)

Indicates the amount that has to be charged from the credit card.

currency_code string (Required)

Indicates the currency accepted by the partner.

order_id string (Required)

A unique order identifier, typically generated by your system to link this payment request to a specific order.

customer_email string

The email address of the customer. This must be a valid email format and should not exceed 50 characters.

contact_number string

The customer’s contact number in international format.

return_url string

The URL to which the user will be redirected after payment is completed. This is typically used to handle post-payment processing.

Sample Request

Responses

Success Response

status string

Indicates the status of the request.

ErrorMessages string

Indicates the error messages, if any.

URL string

A link to the payment page where the customer can complete the payment process. This URL will be generated upon success and should be used to redirect the user to the payment interface.

Error Response

status string

Indicates the status of the request.

ErrorMessages string

An array containing specific error messages that describe why the request failed. In this example, the error relates to the invalid or missing customer_email.