Skip to main content

Subscription Callback

Unlike request-based methods initiated by the integrator, the subscription callback is initiated by the Keepz payment system. The integrator must implement an endpoint to receive and handle these callbacks.

The purpose of this callback is to notify the integrator whenever a subscription cycle has been invoked and successfully processed.

Callbacks will be sent in the following cases:

  • A scheduled subscription payment has been completed successfully.

  • A subscription payment attempt has failed or was not completed.

  • A subscription payment has been refunded (partially or fully).

Subscription details are sent to the callback URL using the POST method.

The callback URL can be provided in two ways:

  • Dynamic – passed when creating the subscription.

  • Static – configured once during integration with Keepz.

To confirm successful receipt of the callback, the integrator must return HTTP status code 200.

Callback Parameters​

ParameterTypePossible Values / FormatDescription
subscriptionIdstring (UUID v4)Unique identifier of the subscription in the Keepz system.
historyIdnumberUnique identifier of the subscription payment in the Keepz system.
statusstringCOMPLETED, FAILED, REFUNDED_BY_KEEPZ, REFUNDED_BY_INTEGRATOR, REFUNDED_BY_OPERATOR, PARTIALLY_REFUNDEDCurrent status of the subscription payment.
amountnumberAmount processed for this subscription payment.