Replace the Provider Allowlist

PUT

whitelabel

providers

curl --request PUT \
  --url https://api-sandbox.y.uno/v1/whitelabel/providers \
  --header 'Content-Type: application/json' \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>' \
  --data '
{
  "provider_ids": [
    "STRIPE",
    "ADYEN",
    "YUNO_3DS"
  ]
}
'

import requests

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

payload = { "provider_ids": ["STRIPE", "ADYEN", "YUNO_3DS"] }
headers = {
    "PUBLIC-API-KEY": "<api-key>",
    "PRIVATE-SECRET-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'PUBLIC-API-KEY': '<api-key>',
    'PRIVATE-SECRET-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({provider_ids: ['STRIPE', 'ADYEN', 'YUNO_3DS']})
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'provider_ids' => [
        'STRIPE',
        'ADYEN',
        'YUNO_3DS'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"provider_ids\": [\n    \"STRIPE\",\n    \"ADYEN\",\n    \"YUNO_3DS\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api-sandbox.y.uno/v1/whitelabel/providers")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider_ids\": [\n    \"STRIPE\",\n    \"ADYEN\",\n    \"YUNO_3DS\"\n  ]\n}")
  .asString();

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::Put.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider_ids\": [\n    \"STRIPE\",\n    \"ADYEN\",\n    \"YUNO_3DS\"\n  ]\n}"

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

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "provider_ids contains an invalid catalogue id"
}

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

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

Replaces the whole set of providers your organization offers with the ids in the body. A provider the body omits stops being offered. This is a replace, not a merge — use Update Several Providers’ Visibility to change some providers without restating the rest. Removing a provider keeps its instruction override, so toggling it off and on again does not lose your wording.

Body

string[]

required

The complete set of provider ids your organization offers. UPPER_SNAKE_CASE catalogue ids ([A-Z0-9_]), at most 100 characters each, at most 500 entries. Case-insensitive — normalized to upper case.An empty array is a legal request and clears the allowlist, the same end state as Clear the Provider Allowlist. A save-everything admin screen therefore needs no special case for “the last provider was unticked”.

Under the opt-in rule, an empty provider_ids leaves your organization with no allowlist entries at all — it is not a “show everything” switch. Send the ids you want to offer rather than clearing the list to widen it.

Response

The refreshed overlay, in the same shape as List the White-label Provider Overlay.

boolean

Whether your organization has at least one allowlist entry, after this change.

object[]

The union of your allowlist, your instruction overrides, and your logo overrides.

curl -X PUT 'https://api.y.uno/v1/whitelabel/providers' \
  -H 'public-api-key: <YOUR_PUBLIC_KEY>' \
  -H 'private-secret-key: <YOUR_SECRET_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{ "provider_ids": ["STRIPE", "ADYEN", "YUNO_3DS"] }'

{
  "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": true,
      "has_instruction_override": false,
      "logo_url": "https://s3.amazonaws.com/whitelabel/logo.png?X-Amz-Signature=..."
    }
  ]
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "provider_ids contains an invalid catalogue id"
}

Errors

HTTP	Envelope	When
`400`	problem+json	An unknown field, more than 500 ids, or an id that is not a valid catalogue id.
`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

Body

application/json

The complete set of provider ids to offer.

provider_ids

string[]

required

The complete set of provider ids the organization offers. UPPER_SNAKE_CASE catalogue ids ([A-Z0-9_]), at most 100 characters each, at most 500 entries.

Maximum array length: 500

Maximum string length: 100

Example:

["STRIPE", "ADYEN", "YUNO_3DS"]

Response

The refreshed overlay.

filtered

boolean

Whether the organization has at least one allowlist entry. 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

Replace the Provider Allowlist

curl --request PUT \
  --url https://api-sandbox.y.uno/v1/whitelabel/providers \
  --header 'Content-Type: application/json' \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>' \
  --data '
{
  "provider_ids": [
    "STRIPE",
    "ADYEN",
    "YUNO_3DS"
  ]
}
'

import requests

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

payload = { "provider_ids": ["STRIPE", "ADYEN", "YUNO_3DS"] }
headers = {
    "PUBLIC-API-KEY": "<api-key>",
    "PRIVATE-SECRET-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'PUBLIC-API-KEY': '<api-key>',
    'PRIVATE-SECRET-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({provider_ids: ['STRIPE', 'ADYEN', 'YUNO_3DS']})
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'provider_ids' => [
        'STRIPE',
        'ADYEN',
        'YUNO_3DS'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"provider_ids\": [\n    \"STRIPE\",\n    \"ADYEN\",\n    \"YUNO_3DS\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api-sandbox.y.uno/v1/whitelabel/providers")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider_ids\": [\n    \"STRIPE\",\n    \"ADYEN\",\n    \"YUNO_3DS\"\n  ]\n}")
  .asString();

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::Put.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider_ids\": [\n    \"STRIPE\",\n    \"ADYEN\",\n    \"YUNO_3DS\"\n  ]\n}"

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

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "provider_ids contains an invalid catalogue id"
}

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

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

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

Body

Response

Errors

Authorizations

Body

Response