Saltar al contenido principal
GET
Listar grupos de éxitos
Lista los grupos de exitosos guardados en una cuenta: grupos de subestados de éxito que referencias con status: "SUCCEEDED_GROUP" en una salida de enrutamiento, para reaccionar de forma distinta ante una autorización que el proveedor retiene para revisión (PENDING_IN_REVIEW) que ante una aprobación simple. Usa el id de un grupo como group_id: consulta Grupos de resultados. El endpoint es de solo lectura. Los grupos de exitosos se crean en el dashboard.

Parámetros de consulta

string
requerido
La cuenta para la que se listan los grupos. Debe pertenecer a la organización a la que están asociadas tus credenciales de API.

Respuesta

Un arreglo con los grupos de la cuenta, o un arreglo vacío si no tiene ninguno. Cada grupo contiene:
integer
El valor que se envía como group_id.
string
El nombre del grupo, tal como se muestra en el dashboard y se devuelve como group_name en las salidas de enrutamiento.
enum
Siempre SUCCEEDED_GROUP, el status de salida con el que se usa el grupo.
string[]
Los miembros del grupo. Hoy el único subestado de éxito que se puede agrupar es PENDING_IN_REVIEW. Consulta Códigos de transacción.

Errores

Autorizaciones

PUBLIC-API-KEY
string
header
predeterminado:<Your PUBLIC-API-KEY>
requerido
PRIVATE-SECRET-KEY
string
header
predeterminado:<Your PRIVATE-SECRET-KEY>
requerido

Parámetros de consulta

account_id
string<uuid>
requerido

Cuenta de la que se listarán los grupos. Debe pertenecer a la organización de tus credenciales de API.

Respuesta

Los grupos de la cuenta, o un arreglo vacío si no tiene ninguno.

id
integer

El valor que se debe enviar como group_id en una salida de enrutamiento.

Ejemplo:

430

name
string
Ejemplo:

"Pending review"

type
enum<string>

Siempre SUCCEEDED_GROUP, el estado de salida con el que se usa el grupo.

Opciones disponibles:
SUCCEEDED_GROUP
succeeded_types
string[]

Miembros del grupo. Hoy el único subestado de éxito que se puede agrupar es PENDING_IN_REVIEW.

Ejemplo: