Skip to Content

PaymentCallbacksApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
handleOrderPaymentCallbackGET /payment-callback/orderHandle payment gateway callback for order transactions.
handleSubscriptionPaymentCallbackGET /payment-callback/subscriptionHandle payment gateway callback for subscription payment transactions.
handleWalletPaymentCallbackGET /payment-callback/walletHandle payment gateway callback for wallet top-up transactions.

handleOrderPaymentCallback

RedirectResponse handleOrderPaymentCallback(code, status, reference, hash, rep_status)

Handle payment gateway callback for order transactions.

Processes the payment result from the gateway after an order payment attempt. Updates order payment status and returns a redirect URL to display the payment result to the user.

Parameters

NameTypeDescriptionNotes
codeStringPayment gateway response code.[optional] [default to null]
statusStringPayment status from the gateway (e.g., “Pagado”, “Autorizada”).[optional] [default to null]
referenceStringTransaction reference or order identifier.[optional] [default to null]
hashStringSecurity hash for verifying callback authenticity.[optional] [default to null]
rep_statusStringAdditional status information from the payment gateway.[optional] [default to null]

Return type

RedirectResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

handleSubscriptionPaymentCallback

RedirectResponse handleSubscriptionPaymentCallback(code, status, reference, hash, rep_status)

Handle payment gateway callback for subscription payment transactions.

Processes the payment result from the gateway after a subscription payment or renewal attempt. Activates or extends subscriptions on success, or marks them as failed for retry, then returns a redirect URL.

Parameters

NameTypeDescriptionNotes
codeStringPayment gateway response code.[optional] [default to null]
statusStringPayment status from the gateway (e.g., “Pagado”, “Autorizada”).[optional] [default to null]
referenceStringTransaction reference for the subscription payment.[optional] [default to null]
hashStringSecurity hash for verifying callback authenticity.[optional] [default to null]
rep_statusStringAdditional status information from the payment gateway.[optional] [default to null]

Return type

RedirectResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

handleWalletPaymentCallback

RedirectResponse handleWalletPaymentCallback(code, status, reference, hash, rep_status)

Handle payment gateway callback for wallet top-up transactions.

Processes the payment result from the gateway after a wallet top-up attempt. Updates wallet balance on success or marks the transaction as failed, then returns a redirect URL.

Parameters

NameTypeDescriptionNotes
codeStringPayment gateway response code.[optional] [default to null]
statusStringPayment status from the gateway (e.g., “Pagado”, “Autorizada”).[optional] [default to null]
referenceStringTransaction reference for the wallet top-up.[optional] [default to null]
hashStringSecurity hash for verifying callback authenticity.[optional] [default to null]
rep_statusStringAdditional status information from the payment gateway.[optional] [default to null]

Return type

RedirectResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8