Update a Provider's Visibility - Yuno API Documentation

PATCH

whitelabel

providers

{provider_id}

Update a Provider's Visibility

curl --request PATCH \
  --url https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id} \
  --header 'Content-Type: application/json' \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>' \
  --data '
{
  "visible": true
}
'

import requests

url = "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}"

payload = { "visible": True }
headers = {
    "PUBLIC-API-KEY": "<api-key>",
    "PRIVATE-SECRET-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'PUBLIC-API-KEY': '<api-key>',
    'PRIVATE-SECRET-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({visible: true})
};

fetch('https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'visible' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "PRIVATE-SECRET-KEY: <api-key>",
    "PUBLIC-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}"

	payload := strings.NewReader("{\n  \"visible\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("PUBLIC-API-KEY", "<api-key>")
	req.Header.Add("PRIVATE-SECRET-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"visible\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"visible\": true\n}"

response = http.request(request)
puts response.read_body

{
  "provider_id": "STRIPE",
  "allowed": true,
  "name": "Acme Risk",
  "instructions": [
    {}
  ],
  "setup_instructions": [
    {}
  ],
  "more_info_url": "https://docs.example.com/stripe",
  "logo_url": "https://s3.amazonaws.com/whitelabel/logo.png?X-Amz-Signature=..."
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "provider_id is invalid"
  ]
}

{
  "code": "NOT_AUTHENTICATED",
  "messages": [
    "Not authenticated"
  ]
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "Request body is too large"
  ]
}

Turns a single provider on or off. Idempotent, and turning it off keeps its instruction override, so your wording survives the toggle. The response is the provider’s refreshed overlay, with allowed reflecting the visible you sent.

Your allowlist is opt-in: a white-label organization with no allowlist entries offers no provider at all. Sending visible: true on such an organization starts the allowlist with that single provider — the rest stay unoffered until you add them one by one, or in bulk with Update Visibility for Several Providers or Replace the Provider Allowlist.

Path Parameters

string

required

Yuno catalogue provider id in UPPER_SNAKE_CASE. Case-insensitive — it is normalized to upper case, so stripe and STRIPE address the same provider.

Body

boolean

required

Whether your organization offers this provider. true adds it to the allowlist, false removes it.Required. A body that omits it, or sends an explicit null, is a 400 — it is never treated as false.

Response

The provider’s refreshed overlay, in the same shape as Retrieve a Provider Overlay.

string

Yuno catalogue provider id, normalized to upper case.

boolean

Whether your organization offers this provider, after this change.

string

Display name replacing the catalogue’s, when overridden.

object[]

Connection steps replacing the catalogue’s, when overridden.

object[]

Grouped setup steps replacing the catalogue’s, when overridden.

string

Documentation link replacing the catalogue’s, when overridden.

string

Presigned on this read and short-lived.

curl -X PATCH 'https://api.y.uno/v1/whitelabel/providers/ADYEN' \
  -H 'public-api-key: <YOUR_PUBLIC_KEY>' \
  -H 'private-secret-key: <YOUR_SECRET_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{ "visible": true }'

{
  "provider_id": "ADYEN",
  "allowed": true
}

{
  "code": "VALIDATION_ERROR",
  "messages": ["provider_id is invalid"]
}

Errors

HTTP	`code`	When
`400`	`VALIDATION_ERROR`	Invalid `provider_id`, or a body with a missing or null `visible`.
`401`	`NOT_AUTHENTICATED`	Missing or invalid API keys.
`413`	—	Request body larger than 256 KB.

Authorizations

PUBLIC-API-KEY

string

header

default:<Your PUBLIC-API-KEY>

required

PRIVATE-SECRET-KEY

string

header

default:<Your PRIVATE-SECRET-KEY>

required

Path Parameters

provider_id

string

required

Yuno catalogue provider id in UPPER_SNAKE_CASE. Case-insensitive; normalized to upper case.

Example:

"STRIPE"

Body

application/json

Whether the organization offers this provider.

visible

boolean

required

Whether the organization offers this provider. true adds it to the allowlist, false removes it. Removing keeps any instruction override. Required — an omitted or null visible is a 400, never a defaulted false.

Example:

true

Response

The provider's refreshed overlay.

provider_id

string

Yuno catalogue provider id, UPPER_SNAKE_CASE.

Example:

"STRIPE"

allowed

boolean

Whether the organization offers this provider.

Example:

true

name

string

Display name replacing the catalogue's, when overridden. Only Yuno-owned providers can carry one.

Example:

"Acme Risk"

instructions

object[]

Connection steps replacing the catalogue's, when overridden. Absent means keep the catalogue's.

setup_instructions

object[]

Grouped setup steps replacing the catalogue's, when overridden. Absent means keep the catalogue's.

more_info_url

string<uri>

Documentation link replacing the catalogue's, when overridden. Always https.

Example:

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

logo_url

string

read-only

Read-only and ephemeral: a presigned URL minted on this read and valid only for a short window. Never store it — read the provider again for a fresh one.

Example:

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

⌘I

Update a Provider's Visibility

curl --request PATCH \
  --url https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id} \
  --header 'Content-Type: application/json' \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>' \
  --data '
{
  "visible": true
}
'

import requests

url = "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}"

payload = { "visible": True }
headers = {
    "PUBLIC-API-KEY": "<api-key>",
    "PRIVATE-SECRET-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'PUBLIC-API-KEY': '<api-key>',
    'PRIVATE-SECRET-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({visible: true})
};

fetch('https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'visible' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "PRIVATE-SECRET-KEY: <api-key>",
    "PUBLIC-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}"

	payload := strings.NewReader("{\n  \"visible\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("PUBLIC-API-KEY", "<api-key>")
	req.Header.Add("PRIVATE-SECRET-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"visible\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"visible\": true\n}"

response = http.request(request)
puts response.read_body

{
  "provider_id": "STRIPE",
  "allowed": true,
  "name": "Acme Risk",
  "instructions": [
    {}
  ],
  "setup_instructions": [
    {}
  ],
  "more_info_url": "https://docs.example.com/stripe",
  "logo_url": "https://s3.amazonaws.com/whitelabel/logo.png?X-Amz-Signature=..."
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "provider_id is invalid"
  ]
}

{
  "code": "NOT_AUTHENTICATED",
  "messages": [
    "Not authenticated"
  ]
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "Request body is too large"
  ]
}