Retrieve a Provider's Instruction Override

GET

whitelabel

providers

{provider_id}

instructions

Retrieve a Provider's Instruction Override

curl --request GET \
  --url https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions \
  --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}/instructions"

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}/instructions', 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}/instructions",
  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}/instructions"

	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}/instructions")
  .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}/instructions")

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",
  "instructions": [
    {}
  ],
  "setup_instructions": [
    {}
  ],
  "more_info_url": "https://docs.example.com/stripe",
  "name": "Acme Risk",
  "created_at": "2026-09-02T13:54:13Z",
  "updated_at": "2026-09-02T13:54:13Z",
  "created_by": "00000000-0000-0000-0000-000000000000",
  "updated_by": "00000000-0000-0000-0000-000000000000"
}

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

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

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "No instruction override for provider STRIPE"
}

Returns the custom connection instructions you have stored for this provider — the focused read an editor loads before saving. A provider with no override answers 404. Use Retrieve a Provider Overlay, which never 404s, when you want the overlay whether or not an override exists.

A field you do not override is absent — not null, not an empty list. Absent means “keep the Yuno catalogue’s value”; present-and-empty means “replace it with nothing”.

Path Parameters

string

required

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

Response

string

Yuno catalogue provider id, normalized to upper case.

object[]

Connection steps replacing the catalogue’s. Each step accepts step, text, text_link, link, type, has_sub_instructions, sub_instructions_type and sub_instructions (nested up to 3 levels). text and text_link are either a plain string or a language map such as {"EN": "...", "ES": "..."}.

object[]

Grouped setup steps replacing the catalogue’s. Each group accepts title, order, instructions_type and instructions (the same step shape).

string

Documentation link replacing the catalogue’s. Always https.

string

Display name replacing the catalogue’s. Only Yuno-owned providers can carry one.

string

ISO 8601 timestamp — when the override was first written.

string

ISO 8601 timestamp — when the override was last written.

string

The dashboard user who created it. Overrides written through this API carry the all-zero sentinel, meaning “written through the API” rather than by a person in the Dashboard.

string

The dashboard user who last updated it, with the same sentinel rule as created_by.

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

{
  "provider_id": "STRIPE",
  "more_info_url": "https://docs.example.com/stripe",
  "instructions": [
    {
      "step": 1,
      "text": { "EN": "Open your Stripe dashboard.", "ES": "Abre tu panel de Stripe." },
      "type": "TEXT"
    },
    {
      "step": 2,
      "text": "Copy the secret API key and paste it below.",
      "text_link": "Where do I find my key?",
      "link": "https://docs.example.com/stripe#api-keys",
      "type": "LINK"
    }
  ],
  "setup_instructions": [
    {
      "title": "Before you start",
      "order": 1,
      "instructions_type": "TEXT",
      "instructions": [
        { "step": 1, "text": "Make sure your Stripe account is activated." }
      ]
    }
  ],
  "created_at": "2026-09-02T13:54:13Z",
  "updated_at": "2026-09-02T13:54:13Z",
  "created_by": "00000000-0000-0000-0000-000000000000",
  "updated_by": "00000000-0000-0000-0000-000000000000"
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "No instruction override for provider STRIPE"
}

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

Errors

HTTP	Envelope	When
`400`	`VALIDATION_ERROR`	`provider_id` is not a valid catalogue id.
`401`	`NOT_AUTHENTICATED`	Missing or invalid API keys.
`404`	problem+json	This provider has no instruction override.

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 stored override.

provider_id

string

Yuno catalogue provider id, UPPER_SNAKE_CASE.

Example:

"STRIPE"

instructions

object[]

Connection steps replacing the catalogue's.

setup_instructions

object[]

Grouped setup steps replacing the catalogue's.

more_info_url

string<uri>

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

Example:

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

name

string

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

Example:

"Acme Risk"

created_at

string<date-time>

read-only

When the override was first written.

Example:

"2026-09-02T13:54:13Z"

updated_at

string<date-time>

read-only

When the override was last written.

Example:

"2026-09-02T13:54:13Z"

created_by

string<uuid>

read-only

The dashboard user who created it. Overrides written through this API carry the all-zero sentinel 00000000-0000-0000-0000-000000000000, meaning "written through the API" rather than by a person in the dashboard.

Example:

"00000000-0000-0000-0000-000000000000"

updated_by

string<uuid>

read-only

The dashboard user who last updated it, with the same sentinel rule as created_by.

Example:

"00000000-0000-0000-0000-000000000000"

⌘I

Retrieve a Provider's Instruction Override

curl --request GET \
  --url https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions \
  --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}/instructions"

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}/instructions', 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}/instructions",
  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}/instructions"

	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}/instructions")
  .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}/instructions")

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",
  "instructions": [
    {}
  ],
  "setup_instructions": [
    {}
  ],
  "more_info_url": "https://docs.example.com/stripe",
  "name": "Acme Risk",
  "created_at": "2026-09-02T13:54:13Z",
  "updated_at": "2026-09-02T13:54:13Z",
  "created_by": "00000000-0000-0000-0000-000000000000",
  "updated_by": "00000000-0000-0000-0000-000000000000"
}

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

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

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "No instruction override for provider STRIPE"
}

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

Retrieve a Provider's Instruction Override

Path Parameters

Response

Errors

Authorizations

Path Parameters

Response

​Path Parameters

​Response

​Errors

Authorizations

Path Parameters

Response

Path Parameters

Response

Errors