TRtrytoku
Customer Portal

Obtener Customer Portal Session

Changed on

Devuelve una Customer Portal Session de la organización con su estado y su url.

Se usa para saber si el enlace que se le entregó al Customer sigue vigente. Si la sesión estaba abierta y su expiration_datetime ya pasó, queda marcada como expired en esta misma lectura.

get/v2/customer-portal-sessions/{session_id}

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/v2/customer-portal-sessions/{session_id}
  • 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.

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