Saltar al contenido principal
PATCH
Actualizar la visibilidad de un proveedor
Activa o desactiva un solo proveedor. Es idempotente, y al desactivarlo se conserva su instrucción personalizada, de modo que tu redacción sobrevive al cambio. La respuesta es la capa actualizada del proveedor, con allowed reflejando el valor de visible que enviaste.
Tu lista de permitidos es opt-in: una organización de marca blanca sin entradas en la lista de permitidos no ofrece ningún proveedor. Enviar visible: true en una organización así inicia la lista de permitidos con ese único proveedor: los demás siguen sin ofrecerse hasta que los agregues uno por uno, o de forma masiva con Actualizar la visibilidad de varios proveedores o Reemplazar la lista de proveedores permitidos.

Parámetros de ruta

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, por lo que stripe y STRIPE direccionan al mismo proveedor.

Cuerpo

boolean
requerido
Indica si tu organización ofrece este proveedor. true lo agrega a la lista de permitidos, false lo elimina.Obligatorio. Un cuerpo que lo omite, o que envía un null explícito, produce un 400: nunca se trata como false.

Respuesta

La capa actualizada del proveedor, con la misma estructura que Obtener la capa de un proveedor.
string
Id del proveedor del catálogo de Yuno, normalizado a mayúsculas.
boolean
Indica si tu organización ofrece este proveedor, después de este cambio.
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 se personaliza.
string
Prefirmada en esta lectura y de corta duració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 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"

Cuerpo

application/json

Indica si la organización ofrece este proveedor.

visible
boolean
requerido

Indica si la organización ofrece este proveedor. true lo agrega a la lista de permitidos, false lo quita. Quitarlo conserva cualquier anulación de instrucciones. Obligatorio: un visible omitido o nulo devuelve 400, nunca se asume false por defecto.

Ejemplo:

true

Respuesta

La superposición actualizada 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=..."