Get Payment Constraints Rules
curl --request GET \
--url https://api.yapily.com/institutions/constraints/payments \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.yapily.com/institutions/constraints/payments"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.yapily.com/institutions/constraints/payments', 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.yapily.com/institutions/constraints/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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.yapily.com/institutions/constraints/payments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.yapily.com/institutions/constraints/payments")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yapily.com/institutions/constraints/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"meta": {
"tracingId": "661471ddb4344113a2d185b861cb3dcf"
},
"data": [
{
"institutionId": "mock-sandbox",
"institutionCountryCode": "GB",
"endpointPath": "/payments",
"endpointMethod": "POST",
"paymentType": "DOMESTIC_PAYMENT",
"request": {
"headers": {
"title": "Header",
"type": "object",
"properties": {
"psuID": {
"title": "PSU Id",
"type": "string",
"description": ""
}
}
},
"body": {
"title": "Payment Request",
"required": [
"payee",
"amount",
"paymentIdempotencyId",
"type"
],
"type": "object",
"properties": {
"paymentIdempotencyId": {
"title": "Payment Idempotency Id",
"pattern": "^.{1,35}$",
"type": "string",
"description": "Id for the payment"
},
"type": {
"enum": [
"DOMESTIC_PAYMENT"
],
"title": "Payment Type",
"type": "string",
"description": "type of the payment"
},
"contextType": {
"default": "OTHER",
"enum": [
"BILL",
"GOODS",
"SERVICES",
"OTHER",
"PERSON_TO_PERSON"
],
"title": "Context Type",
"type": "string",
"description": "__Optional__. The payment context code. This defaults to `OTHER` if not specified."
},
"reference": {
"title": "Reference",
"pattern": "^.{1,18}$",
"type": "string",
"description": "__Mandatory__. The payment reference or description. Limited to a maximum of 18 characters long.",
"example": "Bill payment"
},
"payee": {
"title": "Payee",
"required": [
"accountIdentifications",
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"pattern": "^.{1,18}$",
"type": "string",
"description": "__Mandatory__. The account holder name of the beneficiary.",
"example": "Jane Doe"
},
"accountIdentifications": {
"title": "Account Identifications",
"type": "array",
"items": {
"required": [
"identification",
"type"
],
"type": "object",
"properties": {
"type": {
"title": "Account Identification Type",
"type": "string",
"description": "__Mandatory__. Used to describe the format of the account.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on when to specify each type."
},
"identification": {
"title": "Account Identification",
"type": "string",
"description": "__Mandatory__. The value associated with the account identification type.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on the format of the values."
}
}
},
"description": "__Mandatory__. The account identifications that identify the `Payee` bank account."
},
"address": {
"title": "Address",
"type": "object",
"properties": {
"addressLines": {
"title": "Address Lines",
"type": "array",
"items": {
"title": "Address Line",
"type": "string"
},
"description": "__Optional__. The address line of the address"
},
"streetName": {
"title": "Street Name",
"type": "string",
"description": "__Optional__. The street name of the address"
},
"buildingNumber": {
"title": "Building Number",
"type": "string",
"description": "__Optional__. The building number of the address"
},
"postCode": {
"title": "Postcode",
"type": "string",
"description": "__Optional__. The post code of the address"
},
"townName": {
"title": "Town",
"type": "string",
"description": "__Optional__. The town name of the address"
},
"county": {
"title": "County",
"type": "array",
"items": {
"type": "string"
},
"description": "__Optional__. The list of counties for the address"
},
"country": {
"title": "Country",
"type": "string",
"description": "__Conditional__. The 2-letter country code for the address. \n\nAn `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment"
},
"department": {
"title": "Department",
"type": "string",
"description": "__Optional__. The department for the address"
},
"subDepartment": {
"title": "Sub-department",
"type": "string",
"description": "__Optional__. The sub-department for the address"
},
"addressType": {
"enum": [
"BUSINESS",
"CORRESPONDENCE",
"DELIVERY_TO",
"MAIL_TO",
"PO_BOX",
"POSTAL",
"RESIDENTIAL",
"STATEMENT",
"UNKNOWN"
],
"title": "Address Type",
"type": "string",
"description": "__Optional__. The type of address"
}
},
"description": "__Conditional__. The address of the `Payee` or `Payer`."
}
},
"description": "__Mandatory__. Details of the beneficiary [person or business]."
},
"payer": {
"title": "Payer",
"required": [
"accountIdentifications"
],
"type": "object",
"properties": {
"accountIdentifications": {
"title": "Account Identifications",
"type": "array",
"items": {
"required": [
"identification",
"type"
],
"type": "object",
"properties": {
"type": {
"enum": [
"IBAN"
],
"title": "Account Identification Type",
"type": "string",
"description": "__Mandatory__. Should be IBAN only."
},
"identification": {
"title": "Account Identification",
"pattern": "DE\\d{20}",
"type": "string",
"description": "__Mandatory__. The IBAN value associated with the account identity"
}
}
},
"description": "__Mandatory__. The account identifications that identify the `Payer` bank account."
},
"address": {
"title": "Address",
"type": "object",
"properties": {
"addressLines": {
"title": "Address Lines",
"type": "array",
"items": {
"title": "Address Line",
"type": "string"
},
"description": "__Optional__. The address line of the address"
},
"streetName": {
"title": "Street Name",
"type": "string",
"description": "__Optional__. The street name of the address"
},
"buildingNumber": {
"title": "Building Number",
"type": "string",
"description": "__Optional__. The building number of the address"
},
"postCode": {
"title": "Postcode",
"type": "string",
"description": "__Optional__. The post code of the address"
},
"townName": {
"title": "Town",
"type": "string",
"description": "__Optional__. The town name of the address"
},
"county": {
"title": "County",
"type": "array",
"items": {
"type": "string"
},
"description": "__Optional__. The list of counties for the address"
},
"country": {
"title": "Country",
"type": "string",
"description": "__Conditional__. The 2-letter country code for the address. \n\nAn `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment"
},
"department": {
"title": "Department",
"type": "string",
"description": "__Optional__. The department for the address"
},
"subDepartment": {
"title": "Sub-department",
"type": "string",
"description": "__Optional__. The sub-department for the address"
},
"addressType": {
"enum": [
"BUSINESS",
"CORRESPONDENCE",
"DELIVERY_TO",
"MAIL_TO",
"PO_BOX",
"POSTAL",
"RESIDENTIAL",
"STATEMENT",
"UNKNOWN"
],
"title": "Address Type",
"type": "string",
"description": "__Optional__. The type of address"
}
},
"description": "__Conditional__. The address of the `Payee` or `Payer`."
}
}
},
"amount": {
"title": "Amount",
"required": [
"amount",
"currency"
],
"type": "object",
"properties": {
"amount": {
"title": "Amount",
"minimum": 0,
"type": "number",
"description": "__Mandatory__. The monetary value"
},
"currency": {
"title": "Currency",
"pattern": "^[A-Z]{3,3}$",
"type": "string",
"description": "__Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code"
}
},
"description": "__Mandatory__. Monetary Amount."
},
"paymentDateTime": {
"type": "string",
"description": "__Optional__, If present date should be greater than or equal to current date",
"format": "date-time"
}
},
"description": "Domestic payment request schema"
}
}
}
]
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 400,
"status": "BAD_REQUEST",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "BAD_REQUEST",
"code": 10600,
"message": "The server could not understand the request due to invalid syntax"
}
]
}
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 401,
"status": "UNAUTHORIZED",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "CREDENTIALS",
"code": 10700,
"message": "Authorization header invalid or credentials not authenticated"
}
]
}
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 404,
"status": "NOT FOUND",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "INVALID_REQUEST",
"code": 10800,
"message": "Resource not found"
}
]
}
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 500,
"status": "INTERNAL SERVER ERROR",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "INTERNAL_SERVER_ERROR",
"code": 11000,
"message": "Unexpected server error"
}
]
}
}Constraints
Get Payment Constraints Rules
Retrieve institution specific constraints for payment authorisation and submission requests
Get Payment Constraints Rules
curl --request GET \
--url https://api.yapily.com/institutions/constraints/payments \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.yapily.com/institutions/constraints/payments"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.yapily.com/institutions/constraints/payments', 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.yapily.com/institutions/constraints/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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.yapily.com/institutions/constraints/payments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.yapily.com/institutions/constraints/payments")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yapily.com/institutions/constraints/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"meta": {
"tracingId": "661471ddb4344113a2d185b861cb3dcf"
},
"data": [
{
"institutionId": "mock-sandbox",
"institutionCountryCode": "GB",
"endpointPath": "/payments",
"endpointMethod": "POST",
"paymentType": "DOMESTIC_PAYMENT",
"request": {
"headers": {
"title": "Header",
"type": "object",
"properties": {
"psuID": {
"title": "PSU Id",
"type": "string",
"description": ""
}
}
},
"body": {
"title": "Payment Request",
"required": [
"payee",
"amount",
"paymentIdempotencyId",
"type"
],
"type": "object",
"properties": {
"paymentIdempotencyId": {
"title": "Payment Idempotency Id",
"pattern": "^.{1,35}$",
"type": "string",
"description": "Id for the payment"
},
"type": {
"enum": [
"DOMESTIC_PAYMENT"
],
"title": "Payment Type",
"type": "string",
"description": "type of the payment"
},
"contextType": {
"default": "OTHER",
"enum": [
"BILL",
"GOODS",
"SERVICES",
"OTHER",
"PERSON_TO_PERSON"
],
"title": "Context Type",
"type": "string",
"description": "__Optional__. The payment context code. This defaults to `OTHER` if not specified."
},
"reference": {
"title": "Reference",
"pattern": "^.{1,18}$",
"type": "string",
"description": "__Mandatory__. The payment reference or description. Limited to a maximum of 18 characters long.",
"example": "Bill payment"
},
"payee": {
"title": "Payee",
"required": [
"accountIdentifications",
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"pattern": "^.{1,18}$",
"type": "string",
"description": "__Mandatory__. The account holder name of the beneficiary.",
"example": "Jane Doe"
},
"accountIdentifications": {
"title": "Account Identifications",
"type": "array",
"items": {
"required": [
"identification",
"type"
],
"type": "object",
"properties": {
"type": {
"title": "Account Identification Type",
"type": "string",
"description": "__Mandatory__. Used to describe the format of the account.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on when to specify each type."
},
"identification": {
"title": "Account Identification",
"type": "string",
"description": "__Mandatory__. The value associated with the account identification type.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on the format of the values."
}
}
},
"description": "__Mandatory__. The account identifications that identify the `Payee` bank account."
},
"address": {
"title": "Address",
"type": "object",
"properties": {
"addressLines": {
"title": "Address Lines",
"type": "array",
"items": {
"title": "Address Line",
"type": "string"
},
"description": "__Optional__. The address line of the address"
},
"streetName": {
"title": "Street Name",
"type": "string",
"description": "__Optional__. The street name of the address"
},
"buildingNumber": {
"title": "Building Number",
"type": "string",
"description": "__Optional__. The building number of the address"
},
"postCode": {
"title": "Postcode",
"type": "string",
"description": "__Optional__. The post code of the address"
},
"townName": {
"title": "Town",
"type": "string",
"description": "__Optional__. The town name of the address"
},
"county": {
"title": "County",
"type": "array",
"items": {
"type": "string"
},
"description": "__Optional__. The list of counties for the address"
},
"country": {
"title": "Country",
"type": "string",
"description": "__Conditional__. The 2-letter country code for the address. \n\nAn `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment"
},
"department": {
"title": "Department",
"type": "string",
"description": "__Optional__. The department for the address"
},
"subDepartment": {
"title": "Sub-department",
"type": "string",
"description": "__Optional__. The sub-department for the address"
},
"addressType": {
"enum": [
"BUSINESS",
"CORRESPONDENCE",
"DELIVERY_TO",
"MAIL_TO",
"PO_BOX",
"POSTAL",
"RESIDENTIAL",
"STATEMENT",
"UNKNOWN"
],
"title": "Address Type",
"type": "string",
"description": "__Optional__. The type of address"
}
},
"description": "__Conditional__. The address of the `Payee` or `Payer`."
}
},
"description": "__Mandatory__. Details of the beneficiary [person or business]."
},
"payer": {
"title": "Payer",
"required": [
"accountIdentifications"
],
"type": "object",
"properties": {
"accountIdentifications": {
"title": "Account Identifications",
"type": "array",
"items": {
"required": [
"identification",
"type"
],
"type": "object",
"properties": {
"type": {
"enum": [
"IBAN"
],
"title": "Account Identification Type",
"type": "string",
"description": "__Mandatory__. Should be IBAN only."
},
"identification": {
"title": "Account Identification",
"pattern": "DE\\d{20}",
"type": "string",
"description": "__Mandatory__. The IBAN value associated with the account identity"
}
}
},
"description": "__Mandatory__. The account identifications that identify the `Payer` bank account."
},
"address": {
"title": "Address",
"type": "object",
"properties": {
"addressLines": {
"title": "Address Lines",
"type": "array",
"items": {
"title": "Address Line",
"type": "string"
},
"description": "__Optional__. The address line of the address"
},
"streetName": {
"title": "Street Name",
"type": "string",
"description": "__Optional__. The street name of the address"
},
"buildingNumber": {
"title": "Building Number",
"type": "string",
"description": "__Optional__. The building number of the address"
},
"postCode": {
"title": "Postcode",
"type": "string",
"description": "__Optional__. The post code of the address"
},
"townName": {
"title": "Town",
"type": "string",
"description": "__Optional__. The town name of the address"
},
"county": {
"title": "County",
"type": "array",
"items": {
"type": "string"
},
"description": "__Optional__. The list of counties for the address"
},
"country": {
"title": "Country",
"type": "string",
"description": "__Conditional__. The 2-letter country code for the address. \n\nAn `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment"
},
"department": {
"title": "Department",
"type": "string",
"description": "__Optional__. The department for the address"
},
"subDepartment": {
"title": "Sub-department",
"type": "string",
"description": "__Optional__. The sub-department for the address"
},
"addressType": {
"enum": [
"BUSINESS",
"CORRESPONDENCE",
"DELIVERY_TO",
"MAIL_TO",
"PO_BOX",
"POSTAL",
"RESIDENTIAL",
"STATEMENT",
"UNKNOWN"
],
"title": "Address Type",
"type": "string",
"description": "__Optional__. The type of address"
}
},
"description": "__Conditional__. The address of the `Payee` or `Payer`."
}
}
},
"amount": {
"title": "Amount",
"required": [
"amount",
"currency"
],
"type": "object",
"properties": {
"amount": {
"title": "Amount",
"minimum": 0,
"type": "number",
"description": "__Mandatory__. The monetary value"
},
"currency": {
"title": "Currency",
"pattern": "^[A-Z]{3,3}$",
"type": "string",
"description": "__Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code"
}
},
"description": "__Mandatory__. Monetary Amount."
},
"paymentDateTime": {
"type": "string",
"description": "__Optional__, If present date should be greater than or equal to current date",
"format": "date-time"
}
},
"description": "Domestic payment request schema"
}
}
}
]
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 400,
"status": "BAD_REQUEST",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "BAD_REQUEST",
"code": 10600,
"message": "The server could not understand the request due to invalid syntax"
}
]
}
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 401,
"status": "UNAUTHORIZED",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "CREDENTIALS",
"code": 10700,
"message": "Authorization header invalid or credentials not authenticated"
}
]
}
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 404,
"status": "NOT FOUND",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "INVALID_REQUEST",
"code": 10800,
"message": "Resource not found"
}
]
}
}{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 500,
"status": "INTERNAL SERVER ERROR",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "INTERNAL_SERVER_ERROR",
"code": 11000,
"message": "Unexpected server error"
}
]
}
}Authorizations
Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.
Query Parameters
Unique Id(s) of the Institution(s) to retrieve the Payment Constraints for. Multiple institutionIds need to be separated by ,
Country code of the Institution(s). Ensure that the country code matches the respective institutionIds; any mismatch will result in an HTTP 404 error response.
Type of payment to retrieve payment constraints for
Available options:
DOMESTIC_PAYMENT, DOMESTIC_INSTANT_PAYMENT, DOMESTIC_VARIABLE_RECURRING_PAYMENT, DOMESTIC_SCHEDULED_PAYMENT, DOMESTIC_PERIODIC_PAYMENT, INTERNATIONAL_PAYMENT, INTERNATIONAL_SCHEDULED_PAYMENT, INTERNATIONAL_PERIODIC_PAYMENT The path on the API that is associated with the operation for which constraints are to be retrieved
The HTTP method that is associated with the operation for which constraints are to be retrieved
Available options:
POST, PATCH, PUT, GET, DELETE Was this page helpful?
⌘I