Payment Flows

Crear Payment Flow

Changed on

Registra el inicio de un payment flow de integración y devuelve su journey_id. Es el punto de entrada que invoca Workato al comenzar un flujo de pago: valida la organización de la ruta (responde HTTP 404 si es desconocida), acuña el journey_id del flujo, resuelve el tipo de flujo (header x-flow o su equivalente en el body) y el identificador externo según la organización, y registra el evento de inicio. El body es de formato libre y se procesa de forma tolerante (un body vacío o no-JSON se trata como vacío). No reenvía la solicitud a ningún otro servicio: responde con el journey_id acuñado para que el llamador lo propague en los pasos siguientes.

Límite de tasa: 20 solicitudes por segundo. Al superarlo, la API responde 429. Ver Límites de tasa.

post/integration-entrypoint-mx/v1/{organization}/payment-flows

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/integration-entrypoint-mx/v1/{organization}/payment-flows
  • Auth
    API key in header x-api-key

Path parameters

organizationstring required

Identificador de la organización en la ruta (por ejemplo el slug o código del cliente de integración).

Example:mapfre-mx

Headers

x-account-keystring

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

Response

Successful Response

external_idstring nullable
flowstring nullable
journey_idstring nullable
organizationstring required

Example response

{
  "external_id": "POL-2026-000123",
  "flow": "collective_policy",
  "journey_id": "jr_pBf2NL0d0gvBM7Ei1E3HIWnTN4W93O",
  "organization": "mapfre-mx"
}

Changes