Saltar al contenido principal
GET
Listar grupos de rechazos
Lista los grupos de rechazo guardados en una cuenta: los grupos de subestados de rechazo que referencias con status: "DECLINE_GROUP" y los grupos de Merchant Advice Codes que referencias con status: "MAC_CODE_GROUP". Usa el id de un grupo como group_id en una salida de enrutamiento; consulta Grupos de resultados. El endpoint es de solo lectura. Los grupos se crean en el dashboard, o automáticamente cuando se guarda una salida DECLINE_GROUP con decline_types y sin group_id (esos se nombran auto_…).

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
El tipo del grupo, según el status de salida con el que coincide: DECLINE_GROUP para un grupo de subestados de rechazo, MAC_CODE_GROUP para un grupo de Merchant Advice Codes. Un grupo de Merchant Advice Codes también puede referenciarse desde una salida DECLINE_GROUP, que coincide de otra forma; consulta Grupos de resultados.
string[]
Los miembros del grupo, en el mismo vocabulario que usan las salidas de enrutamiento: subestados de rechazo como DECLINED_BY_BANK para DECLINE_GROUP, Merchant Advice Codes normalizados como NO_RETRY_POLICY para MAC_CODE_GROUP. 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:

1044

name
string
Ejemplo:

"Soft declines"

type
enum<string>

El estado de salida con el que se usa el grupo.

Opciones disponibles:
DECLINE_GROUP,
MAC_CODE_GROUP
decline_types
string[]

Miembros del grupo: subestados de rechazo para DECLINE_GROUP, Merchant Advice Codes normalizados para MAC_CODE_GROUP.

Ejemplo: