Update Several Providers' Visibility

PATCH

whitelabel

providers

curl --request PATCH \
  --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 '
{
  "providers": [
    {
      "provider_id": "STRIPE",
      "visible": true
    }
  ]
}
'

import requests

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

payload = { "providers": [
        {
            "provider_id": "STRIPE",
            "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({providers: [{provider_id: 'STRIPE', visible: true}]})
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'providers' => [
        [
                'provider_id' => 'STRIPE',
                '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"

	payload := strings.NewReader("{\n  \"providers\": [\n    {\n      \"provider_id\": \"STRIPE\",\n      \"visible\": true\n    }\n  ]\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")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"providers\": [\n    {\n      \"provider_id\": \"STRIPE\",\n      \"visible\": true\n    }\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::Patch.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"providers\": [\n    {\n      \"provider_id\": \"STRIPE\",\n      \"visible\": true\n    }\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_id must appear at most once per request; repeated: STRIPE"
}

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

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

Turns the named providers on or off in one request. Only the providers you list are touched — every other provider keeps whatever it had, which is what separates this from Replace the Provider Allowlist. Idempotent, and turning a provider off keeps its instruction override.

The whole request is validated before the first row is written: a repeated provider_id changes nothing rather than half of what you asked for.

Body

object[]

required

The providers whose visibility changes in this request. At most 500 entries, and each provider_id may appear at most once.

Show item

string

required

Yuno catalogue provider id in UPPER_SNAKE_CASE. Case-insensitive — normalized to upper case before the repeat check, so stripe and STRIPE count as the same entry.

boolean

required

Whether your organization offers this provider. visible: false on a provider that is not on the allowlist is a no-op.

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 PATCH '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 '{
    "providers": [
      { "provider_id": "STRIPE", "visible": true },
      { "provider_id": "DLOCAL", "visible": false }
    ]
  }'

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

{
  "title": "Bad Request",
  "status": 400,
  "detail": "provider_id must appear at most once per request; repeated: STRIPE"
}

Errors

HTTP	Envelope	When
`400`	problem+json	A `provider_id` appears more than once, an id is not a valid catalogue id, more than 500 entries, or an unknown field.
`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 providers whose visibility changes.

providers

object[]

required

The providers whose visibility changes in this request. At most 500 entries, each provider_id at most once.

Maximum array length: 500

Show child attributes

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

Update Several Providers' Visibility

curl --request PATCH \
  --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 '
{
  "providers": [
    {
      "provider_id": "STRIPE",
      "visible": true
    }
  ]
}
'

import requests

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

payload = { "providers": [
        {
            "provider_id": "STRIPE",
            "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({providers: [{provider_id: 'STRIPE', visible: true}]})
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'providers' => [
        [
                'provider_id' => 'STRIPE',
                '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"

	payload := strings.NewReader("{\n  \"providers\": [\n    {\n      \"provider_id\": \"STRIPE\",\n      \"visible\": true\n    }\n  ]\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")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"providers\": [\n    {\n      \"provider_id\": \"STRIPE\",\n      \"visible\": true\n    }\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::Patch.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"providers\": [\n    {\n      \"provider_id\": \"STRIPE\",\n      \"visible\": true\n    }\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_id must appear at most once per request; repeated: STRIPE"
}

{
  "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