Saltar al contenido principal
GET
Listar destinatarios
Proporciona account_id como parámetro de consulta, o X-Account-Code como encabezado. Si ambos están presentes, el parámetro de consulta tiene prioridad. Los resultados se limitan a esa cuenta autorizada y a tu organización, ordenados por fecha de creación, del más reciente al más antiguo. Usa merchant_recipient_id para una coincidencia exacta, opcionalmente combinado con country y national_entity. Cada respuesta exitosa contiene data como un arreglo y pagination como un objeto, incluso cuando solo coincide un destinatario. Si no hay coincidencias, devuelve HTTP 200 con data: [] y pagination.total: 0. limit tiene un valor predeterminado de 20 y acepta de 1 a 100. offset tiene un valor predeterminado de 0 y acepta cualquier entero no negativo. Los valores de filtro vacíos o repetidos no son válidos. Cada elemento contiene los campos base del destinatario. Las colecciones relacionadas como withdrawal_methods, documentation, legal_representatives y onboardings no se enriquecen. Usa Get Recipient para obtener el destinatario completo.
Los resultados del listado, incluidos los filtros por ID de comercio, tienen consistencia eventual. Un destinatario que acabas de crear, actualizar o eliminar puede tardar en reflejarse en la lista. Usa Get Recipient con su ID de Yuno para una lectura inmediata desde el almacén principal. Los fallos de acceso a datos del listado devuelven 503; no se representan como resultados vacíos.
Este listado está disponible en GET /v1/recipients/list. La búsqueda existente Get Recipient by Merchant ID (GET /v1/recipients?merchant_recipient_id=...) permanece sin cambios: devuelve un objeto de destinatario de nivel superior y 400 RECIPIENT_NOT_FOUND cuando ningún destinatario coincide. Quienes ya usan la búsqueda no necesitan migrar. Los contratos de GET por ID de Yuno y de PATCH/DELETE no cambian.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido

Encabezados

X-Account-Code
string<uuid>

UUID de la cuenta autorizada cuando se omite account_id. Si ambos están presentes, account_id tiene prioridad.

Parámetros de consulta

limit
integer
predeterminado:20

Número máximo de destinatarios que se devolverán

Rango requerido: 1 <= x <= 100
offset
integer
predeterminado:0

Número de destinatarios que se omitirán para la paginación

Rango requerido: x >= 0
national_entity
enum<string>

Filtrar destinatarios por tipo de entidad nacional

Opciones disponibles:
INDIVIDUAL,
ENTITY
country
string

Filtrar destinatarios por país

merchant_recipient_id
string

Filtro exacto por ID de destinatario del comercio. Devuelve el mismo arreglo de datos y envoltorio de paginación; si no hay coincidencias, devuelve un arreglo vacío con total 0.

Minimum string length: 1
account_id
string<uuid>

UUID de la cuenta autorizada. Obligatorio, a menos que se envíe X-Account-Code en el encabezado de la solicitud.

Respuesta

Lista de destinatarios obtenida correctamente

data
object[]
pagination
object