TRtrytoku
Customer Portal

Expirar Customer Portal Session

Changed on

Expira una Customer Portal Session para invalidar su enlace antes de la fecha prevista.

Es idempotente: una sesión ya expirada se devuelve tal cual. Las Checkout Sessions abiertas que hayan nacido de esta sesión también quedan expiradas.

post/v2/customer-portal-sessions/{session_id}/expire

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/v2/customer-portal-sessions/{session_id}/expire
  • Auth
    API key in header x-api-key

Path parameters

session_idstring required

Id de la Customer Portal Session, tal como se devolvió al crearla.

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Response

Successful Response

additional_metadataobject
additional_query_parametersobject
billing_dataobject required
communication_channelstring
expiration_datetimestring date-time required
external_idstring
flow_namestring required
idstring required
id_organizationinteger required
journey_idstring
payment_options_configurationobject
redirection_configurationobject
state'open' | 'expired' required

Estado de una sesión del portal de pago. Nace open, que es el único estado en que la sesión sirve para entrar al portal, y pasa a expired cuando se cumple su fecha de expiración o cuando se la expira a propósito. Es un cambio de una sola vía: una sesión expirada no vuelve a abrirse.

templatestring
urlstring required

Changes