Saltar al contenido principal
GET
Obtener la superposición de un proveedor
Devuelve la personalización de tu organización sobre un único proveedor: si lo ofreces, y cualquier nombre, instrucciones, enlace de documentación y logo personalizados.
Este endpoint nunca devuelve 404. Un proveedor que nunca has modificado responde 200 con allowed y sin campos de personalización: exactamente lo que necesita un editor para mostrar un formulario vacío. Usa Recuperar la personalización de instrucciones de un proveedor cuando necesites saber específicamente si existe una personalización.
Un campo ausente significa “conserva el valor del catálogo de Yuno para ese campo”. Una personalización reemplaza un campo por completo y nunca se fusiona con él.

Parámetros de ruta

string
requerido
Id del proveedor del catálogo de Yuno en UPPER_SNAKE_CASE (STRIPE, ADYEN, YUNO_3DS, …). No distingue mayúsculas de minúsculas: se normaliza a mayúsculas.

Respuesta

string
Id del proveedor del catálogo de Yuno, normalizado a mayúsculas.
boolean
Indica si tu organización ofrece este proveedor.
string
Nombre para mostrar que reemplaza al del catálogo, cuando está personalizado.
object[]
Pasos de conexión que reemplazan a los del catálogo, cuando se personalizan.
object[]
Pasos de configuración agrupados que reemplazan a los del catálogo, cuando se personalizan.
string
Enlace de documentación que reemplaza al del catálogo, cuando está personalizado. Siempre https.
string
Prefirmada en esta lectura, válida solo durante un período corto, y nunca la misma dos veces.
logo_url se prefirma en cada lectura y caduca poco después. Muéstrala de inmediato; nunca la persistas ni la guardes en caché.

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 ruta

provider_id
string
requerido

ID del proveedor del catálogo de Yuno en UPPER_SNAKE_CASE. No distingue mayúsculas de minúsculas; se normaliza a mayúsculas.

Ejemplo:

"STRIPE"

Respuesta

La superposición del proveedor.

provider_id
string

ID del proveedor del catálogo de Yuno, UPPER_SNAKE_CASE.

Ejemplo:

"STRIPE"

allowed
boolean

Indica si la organización ofrece este proveedor.

Ejemplo:

true

name
string

Nombre visible que reemplaza al del catálogo, cuando se personaliza. Solo los proveedores propiedad de Yuno pueden tener uno.

Ejemplo:

"Acme Risk"

instructions
object[]

Pasos de conexión que reemplazan a los del catálogo, cuando se personalizan. Si está ausente, se conservan los del catálogo.

setup_instructions
object[]

Pasos de configuración agrupados que reemplazan a los del catálogo, cuando se personalizan. Si está ausente, se conservan los del catálogo.

more_info_url
string<uri>

Enlace a la documentación que reemplaza al del catálogo, cuando se personaliza. Siempre https.

Ejemplo:

"https://docs.example.com/stripe"

logo_url
string
read-only

Solo lectura y efímera: una URL prefirmada generada en esta lectura y válida solo durante una ventana corta. Nunca la almacenes: vuelve a leer el proveedor para obtener una nueva.

Ejemplo:

"https://s3.amazonaws.com/whitelabel/logo.png?X-Amz-Signature=..."