2. Sale/Rollback

You can use this service to send a sync sale rollback command to your terminals.

POST {{Base Address}}/api/payment/sync/sale/rollback

You only need to send a request to the address provided above. You can use the 'Base Address' as desired for both the test environment and the production environment.

You cannot revoke your cancel commands within the first 5 seconds.

Cancel commands triggered on the device cannot be revoked. In order for cancel commands to be revoked, they must not have been received by the device.

Important: To use the Sync Sale Rollback service, you must include the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' section of your request.

PhysicalAPI Address

The header information that needs to be sent to the service is as follows:

Parameter	Type	Compulsory	Description
apikeyprivate	string	Yes	The Private Key obtained from the merchant panel.
apiclientprivate	string	Yes	The Private Client obtained from the merchant panel.

The body information that needs to be sent to the service is as follows:

JSON

{
    "PaymentRequestId": "cc67bd38-ed83-4031-8be7-3ed4b80b7042"
}

Parameter	Type	Compulsory	Description
PaymentRequestId	Guid	Yes	The identification information returned by Paywall at the time of the sales order.

Response returned from the service:

Parameter	Type	Description
Result	object	Returns the information in the details of the service.
ErrorCode	int	Error code. Returns the value '0' if the transaction is successful.
Succeeded	bool	Returns a true or false value. Returns 'true' if the transaction is successful.
Failed	bool	Returns a true or false value. Returns 'true' if the transaction is unsuccessful.
Message	string	If the transaction is erroneous, this is the message related to the error. It provides language support based on the locale parameter.
ClientMessage	string	Returns the fixed values of the Paywall error codes. You can perform mapping.

JSON

{
    "Result": {
        "PaymentRequestId": "fb9c4719-945d-45b9-9f9c-fd79d8e4af85",
        "PaymentRequestActivityId": "3653663e-6237-42b3-8255-3951959c3fe1",
        "PaymentRequestActivityTypeId": 1,
        "PaymentStatus": 12
    },
    "Failed": false,
    "Message": null,
    "ClientMessage": null,
    "Succeeded": true
}

Parameter	Type	Description
PaymentRequestId	Guid	The identity information of the Async payment in Paywall. It should be stored.
PaymentRequestActivityId	Guid	It is the identity information of the last transaction of the Async payment.
PaymentRequestActivityTypeId	int	The transaction type of the last Async payment. See: Payment Type
PaymentStatus	int	The last status of the Async payment. See: Payment Status