List the White-label Provider Overlay

GET

whitelabel

providers

curl --request GET \
  --url https://api-sandbox.y.uno/v1/whitelabel/providers \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>'

import requests

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

headers = {
    "PUBLIC-API-KEY": "<api-key>",
    "PRIVATE-SECRET-KEY": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'PUBLIC-API-KEY': '<api-key>', 'PRIVATE-SECRET-KEY': '<api-key>'}
};

fetch('https://api-sandbox.y.uno/v1/whitelabel/providers', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("PUBLIC-API-KEY", "<api-key>")
	req.Header.Add("PRIVATE-SECRET-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'

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

{
  "filtered": true,
  "providers": [
    {
      "provider_id": "STRIPE",
      "allowed": true,
      "has_instruction_override": 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": "NOT_AUTHENTICATED",
  "messages": [
    "Not authenticated"
  ]
}

Returns your organization’s overlay on the Yuno provider catalogue: which providers your dashboard offers, and the custom wording, links and logos you have set for them. It is an overlay, not the catalogue. Read the provider catalogue separately and join this on top — this response only covers providers you have an opinion about.

This filters a picker. It is not authorization: it does not stop a connection being created against a provider you do not offer.

Response

boolean

Whether your organization has at least one allowlist entry. false means a white-label organization currently offers no provider at all (the allowlist is opt-in), not that everything is offered. Branch on this, never on the length of providers — the list is also non-empty when your only entries are instruction or logo overrides.

object[]

The union of your allowlist, your instruction overrides, and your logo overrides. A provider can carry custom wording or a custom logo without being offered, in which case it appears here with allowed: false.

Show item

string

Yuno catalogue provider id, UPPER_SNAKE_CASE.

boolean

Whether your organization offers this provider.

boolean

Whether any instruction override exists. A cheap badge flag — redundant with the content fields below, and not authoritative for rendering them.

string

Display name replacing the catalogue’s, when overridden. Absent means keep the catalogue’s.

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. Always https.

string

Presigned on this read and short-lived. Never store it — read again for a fresh one.

curl -X GET 'https://api.y.uno/v1/whitelabel/providers' \
  -H 'public-api-key: <YOUR_PUBLIC_KEY>' \
  -H 'private-secret-key: <YOUR_SECRET_KEY>'

{
  "filtered": true,
  "providers": [
    {
      "provider_id": "ADYEN",
      "allowed": true,
      "has_instruction_override": false
    },
    {
      "provider_id": "STRIPE",
      "allowed": true,
      "has_instruction_override": true,
      "more_info_url": "https://docs.example.com/stripe"
    },
    {
      "provider_id": "YUNO_3DS",
      "allowed": false,
      "has_instruction_override": false,
      "logo_url": "https://s3.amazonaws.com/whitelabel/logo.png?X-Amz-Signature=..."
    }
  ]
}

{
  "filtered": false,
  "providers": []
}

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

YUNO_3DS in the example above is not offered (allowed: false) and still appears, because it carries a custom logo. This is why allowed has to be read per provider rather than inferred from the list’s contents.

Errors

HTTP	`code`	When
`401`	`NOT_AUTHENTICATED`	Missing or invalid API keys.

Authorizations

PUBLIC-API-KEY

string

header

default:<Your PUBLIC-API-KEY>

required

PRIVATE-SECRET-KEY

string

header

default:<Your PRIVATE-SECRET-KEY>

required

Response

The organization's provider overlay.

filtered

boolean

Whether the organization has at least one allowlist entry. false means a white-label organization currently offers no provider at all (the allowlist is opt-in), not that everything is offered. Branch on this, never on the length of providers — the list is also non-empty when the only entries are instruction or logo overrides.

Example:

true

providers

object[]

The union of the allowlist, the instruction overrides, and the logo overrides. A provider can carry custom wording or a custom logo without being offered, in which case it appears with allowed: false.

Show child attributes

⌘I

List the White-label Provider Overlay

curl --request GET \
  --url https://api-sandbox.y.uno/v1/whitelabel/providers \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>'

import requests

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

headers = {
    "PUBLIC-API-KEY": "<api-key>",
    "PRIVATE-SECRET-KEY": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'PUBLIC-API-KEY': '<api-key>', 'PRIVATE-SECRET-KEY': '<api-key>'}
};

fetch('https://api-sandbox.y.uno/v1/whitelabel/providers', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("PUBLIC-API-KEY", "<api-key>")
	req.Header.Add("PRIVATE-SECRET-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'

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

{
  "filtered": true,
  "providers": [
    {
      "provider_id": "STRIPE",
      "allowed": true,
      "has_instruction_override": 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": "NOT_AUTHENTICATED",
  "messages": [
    "Not authenticated"
  ]
}

Getting Started

Reference

Customers

Network Tokens

Customer Sessions (Enrollment)

Checkout Sessions

Payment Methods (Checkout)

Checkout Builder

Payment Methods (Direct Workflow)

PCI Proxy

Payments

Pre-Debit Notifications

3DS2 Setup

Unreferenced Refunds

Dry-run

Transaction Reporting

Routing Recommendations

Payment Links

Recipients for Marketplace

Sellers (Franchise)

Subscriptions Plans

Subscriptions

Payouts

Organizations

Reports

Installments

AI Caller

Communications Campaigns

Conversion Rate

Banking Connectivity

Webhooks

Response

Errors

Authorizations

Response

​Response

​Errors

Authorizations

Response

Response

Errors