Retrieve a Provider Overlay

GET

whitelabel

providers

{provider_id}

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

import requests

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

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/{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 => "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/{provider_id}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .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::Get.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'

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"
  ]
}

Returns your organization’s overlay on a single provider: whether you offer it, and any custom name, instructions, documentation link and logo.

This endpoint never returns 404. A provider you have never touched answers 200 with allowed and no override fields — exactly what an editor needs to render an empty form. Use Retrieve a Provider’s Instruction Override instead when you specifically need to know whether an override exists.

A field that is absent means “keep the Yuno catalogue’s value for it”. An override replaces a field wholesale and never merges into it.

Path Parameters

string

required

Yuno catalogue provider id in UPPER_SNAKE_CASE (STRIPE, ADYEN, YUNO_3DS, …). Case-insensitive — it is normalized to upper case.

Response

string

Yuno catalogue provider id, normalized to upper case.

boolean

Whether your organization offers this provider.

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

string

Presigned on this read, valid only for a short window, and never the same twice.

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

{
  "provider_id": "STRIPE",
  "allowed": false
}

{
  "provider_id": "YUNO_3DS",
  "allowed": true,
  "name": "Acme Risk",
  "more_info_url": "https://docs.example.com/acme-risk",
  "logo_url": "https://s3.amazonaws.com/whitelabel/logo.png?X-Amz-Signature=..."
}

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

logo_url is presigned on every read and expires shortly after. Render it immediately; never persist or cache it.

Errors

HTTP	`code`	When
`400`	`VALIDATION_ERROR`	`provider_id` is not a valid catalogue id (`[A-Z0-9_]`, at most 100 characters).
`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

Path Parameters

provider_id

string

required

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

Example:

"STRIPE"

Response

The provider's 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

Retrieve a Provider Overlay

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

import requests

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

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/{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 => "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/{provider_id}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .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::Get.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'

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"
  ]
}

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

FX Rates

Banking Connectivity

Webhooks

Path Parameters

Response

Errors

Authorizations

Path Parameters

Response