GET/api/processes/{processId}

Consultar un proceso

Devuelve el estado del proceso que devolvió una petición de escritura. Es la fuente de verdad del resultado, incluso cuando se registró una URL de notificación.

Deja de consultar cuando la respuesta deje de traer el header Retry-After, no cuando veas un valor concreto de status.status.

Parámetros

  • Name
    processId
    Type
    processId
    is Required
    REQUERIDO
    Description

    Identificador del proceso, tal como lo devolvió la petición de escritura.

    Ejemplo:01kz0609xy2hd666mnx6b0jxpc

Cabecera

  • Name
    Authorization
    Type
    Authorization
    is Required
    REQUERIDO
    Description

    Token de acceso con el permiso onboarding:read.

    Ejemplo:Bearer 1|tu-token-de-acceso

Solicitud

GET
/api/processes/{processId}
curl --request GET \
  --url '{URL_BASE}/api/processes/01kz0609xy2hd666mnx6b0jxpc' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {TU_TOKEN}'

Respuesta

Estado actual del proceso. Un proceso fallido también responde 200: la consulta funcionó y está informando de un fallo.

  • Name
    status
    Type
    Status
    is Required
    REQUERIDO
    Description

    Estado de la petición o del proceso. Presente en todas las respuestas.

    El código HTTP dice si la llamada funcionó; status.status dice qué pasó con el proceso.

  • Name
    processId
    Type
    string
    is Required
    REQUERIDO
    Description

    Identificador del proceso, en minúsculas.

    Ejemplo:01kz0609xy2hd666mnx6b0jxpc
  • Name
    action
    Type
    string
    is Required
    REQUERIDO
    Description

    Operación que el proceso ejecuta.

    Valores permitidos:merchant.createmerchant.update
    Ejemplo:merchant.create
  • Name
    result
    Type
    is Required
    REQUERIDO
    Description

    Lo que quedó registrado. Es un objeto extensible: pueden aparecer claves nuevas sin que se considere un cambio incompatible, así que ignora las que no conozcas.

  • Name
    errors
    Type
    object
    is optional
    Description

    Presente solo cuando el fallo puede atribuirse a campos concretos. Sus claves son las rutas del cuerpo que enviaste, igual que en un 422.

  • Name
    notification
    Type
    is optional
    Description

    Estado de la entrega del webhook de este proceso.

Respuesta

{
  "status": {
    "status": "PENDING",
    "reason": null,
    "message": "The request is waiting to be processed.",
    "date": "2026-08-17T10:14:03-05:00"
  },
  "processId": "01kz0609xy2hd666mnx6b0jxpc",
  "action": "merchant.create",
  "result": null,
  "notification": null
}