List Decline Groups

GET

routing

decline-groups

List Decline Groups

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

import requests

url = "https://api-sandbox.y.uno/v1/routing/decline-groups"

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/routing/decline-groups', 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/routing/decline-groups",
  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/routing/decline-groups"

	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/routing/decline-groups")

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

[
  {
    "id": 1044,
    "name": "Soft declines",
    "type": "DECLINE_GROUP",
    "decline_types": [
      "DECLINED_BY_BANK",
      "RESTRICTED_BY_BANK"
    ]
  }
]

{
  "code": "ROUTING_VALIDATION_FAILED",
  "messages": [
    "account_id is required."
  ]
}

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

{
  "code": "ROUTING_UPSTREAM_ERROR",
  "messages": [
    "routing service unavailable."
  ]
}

Lists the decline groups saved on an account: the groups of decline sub-statuses you reference with status: "DECLINE_GROUP" and the groups of Merchant Advice Codes you reference with status: "MAC_CODE_GROUP". Use the id of a group as group_id in a routing output — see Outcome groups. The endpoint is read only. Groups are created in the dashboard, or automatically when a DECLINE_GROUP output is saved with decline_types and no group_id (those are named auto_…).

Query Parameters

string

required

The account to list groups for. Must belong to the organization your API credentials are scoped to.

Response

An array with the groups of the account, or an empty array if it has none. Each group contains:

integer

The value to send as group_id.

string

The group’s name, as shown in the dashboard and returned as group_name on routing outputs.

enum

The output status the group is used with: DECLINE_GROUP for a group of decline sub-statuses, MAC_CODE_GROUP for a group of Merchant Advice Codes.

string[]

The group’s members, in the same vocabulary routing outputs use: decline sub-statuses such as DECLINED_BY_BANK for DECLINE_GROUP, normalized Merchant Advice Codes such as NO_RETRY_POLICY for MAC_CODE_GROUP. See Transaction codes.

curl -X GET 'https://api.y.uno/v1/routing/decline-groups?account_id=7825fc5e-e50a-4248-9ae8-5d3786afb0be' \
  -H 'public-api-key: <YOUR_PUBLIC_KEY>' \
  -H 'private-secret-key: <YOUR_SECRET_KEY>'

[
  {
    "id": 1044,
    "name": "Soft declines",
    "type": "DECLINE_GROUP",
    "decline_types": ["DECLINED_BY_BANK", "RESTRICTED_BY_BANK"]
  },
  {
    "id": 4542,
    "name": "Do not retry",
    "type": "MAC_CODE_GROUP",
    "decline_types": ["NO_RETRY_POLICY", "NO_RETRY_SECURITY"]
  }
]

{
  "code": "ROUTING_VALIDATION_FAILED",
  "messages": ["account_id is required."]
}

Errors

HTTP	`code`	When
`400`	`ROUTING_VALIDATION_FAILED`	Missing `account_id` query parameter.
`400`	`INVALID_ACCOUNT_ID`	`account_id` belongs to an organization your API key doesn’t own.
`401`	`NOT_AUTHENTICATED`	Missing `public-api-key` or `private-secret-key` header.
`401`	`INVALID_CREDENTIALS`	Wrong key pair, or a Dashboard Customized API key was used. Use an account key or organization key instead.
`502`	`ROUTING_UPSTREAM_ERROR`	The routing service could not be reached. Retry the request.

Authorizations

PUBLIC-API-KEY

string

header

default:<Your PUBLIC-API-KEY>

required

PRIVATE-SECRET-KEY

string

header

default:<Your PRIVATE-SECRET-KEY>

required

Query Parameters

account_id

string<uuid>

required

Account to list groups for. Must belong to the organization of your API credentials.

Response

The groups of the account, or an empty array if it has none.

integer

The value to send as group_id in a routing output.

Example:

1044

name

string

Example:

"Soft declines"

type

enum<string>

The output status the group is used with.

Available options:

DECLINE_GROUP,

MAC_CODE_GROUP

decline_types

string[]

Members of the group: decline sub-statuses for DECLINE_GROUP, normalized Merchant Advice Codes for MAC_CODE_GROUP.

Example:

["DECLINED_BY_BANK", "RESTRICTED_BY_BANK"]

⌘I

List Decline Groups

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

import requests

url = "https://api-sandbox.y.uno/v1/routing/decline-groups"

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/routing/decline-groups', 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/routing/decline-groups",
  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/routing/decline-groups"

	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/routing/decline-groups")

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

[
  {
    "id": 1044,
    "name": "Soft declines",
    "type": "DECLINE_GROUP",
    "decline_types": [
      "DECLINED_BY_BANK",
      "RESTRICTED_BY_BANK"
    ]
  }
]

{
  "code": "ROUTING_VALIDATION_FAILED",
  "messages": [
    "account_id is required."
  ]
}

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

{
  "code": "ROUTING_UPSTREAM_ERROR",
  "messages": [
    "routing service unavailable."
  ]
}

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

Query Parameters

Response

Errors

Authorizations

Query Parameters

Response

​Query Parameters

​Response

​Errors

Authorizations

Query Parameters

Response

Query Parameters

Response

Errors