Skip to main content
View as Markdown

Deactivate Pre-Order

This endpoint allows a merchant to deactivate an active payment link before its scheduled expiration time. Once deactivated, the link will no longer be valid, and the customer will not be able to access the payment page to complete the transaction.

MethodoptionalPOST

The HTTP method used for this endpoint.

Endpoint URIoptionalstring

/v1/pre-order/{pre_order_id}/deactivate

Descriptionoptionalstring

Deactivate an active pre-order link, preventing any future payment attempts.

Path Parameters​

pre_order_idrequiredstring

The unique identifier of the pre-order to be deactivated.

Headers: See Common Headers​

AuthorizationrequiredBearer Token

The JWT access_token for authenticating the API call.

Request Body​

The request for this endpoint does not require a body.

Response (200 OK):​

A successful deactivation will return a confirmation message.

resultobject

An object containing the outcome of the deactivation request.

result.keystring

Key indicating the result (e.g., "success").

result.messagestring

Result description.

RESPONSE
{
    "result": {
        "key": "success",
        "message": "Successful pre-order deactivation"
    }
}