List an organization's payment policy conditions
curl --request GET \
--url https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditionsimport requests
url = "https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions', 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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions"
req, _ := http.NewRequest("GET", url, nil)
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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"context": "PAYMENT",
"subjects": [
"PIX"
],
"logic": [
"AND"
],
"operators": [
{
"operator": "GREATER_THAN",
"valueKind": "single",
"label": "maior que",
"description": "O campo é maior que o valor informado."
}
],
"fields": [
{
"field": "amount",
"type": "integer",
"operators": [
"EQUALS"
],
"viewOperator": [
"EQUALS"
],
"viewType": {
"type": "MONEY",
"prefix": "<string>",
"suffix": "<string>",
"options": [
{
"id": "PIX",
"label": "PIX",
"icon": "<string>"
}
],
"dynamicOptions": "WALLETS"
},
"label": "Valor",
"description": "Valor principal do pagamento. Todo dinheiro é um inteiro em centavos.",
"availability": {
"PIX": "always",
"BOLETO": "always",
"WALLET_TRANSFER_REQUEST": "always"
},
"unit": "centavos",
"enumValues": [
"<string>"
],
"availabilityNote": "<string>",
"dateKind": {
"PIX": "CALENDAR_DATE",
"BOLETO": "CALENDAR_DATE",
"WALLET_TRANSFER_REQUEST": "CALENDAR_DATE"
},
"customField": {
"id": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b",
"slug": "cost-center",
"type": "SELECT",
"required": false,
"entity": "transaction",
"location": "TRANSACTION",
"mask": "<string>"
}
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BUSINESS_POLICY_FORBIDDEN",
"origin": "RULE_ENGINE",
"message": "You do not have permission to manage business policies"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "RULE_ENGINE",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "organizationId",
"message": "Invalid UUID",
"code": "ORGANIZATIONID_UUID"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "CUSTOM_FIELD_CATALOG_UNAVAILABLE",
"origin": "RULE_ENGINE",
"message": "Could not load the organization's custom fields — try again"
}List an organization's payment policy conditions
Lists the condition fields a PAYMENT business policy can use, with the operators and values each accepts.
GET
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
business-policies
/
payment-conditions
List an organization's payment policy conditions
curl --request GET \
--url https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditionsimport requests
url = "https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions', 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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions"
req, _ := http.NewRequest("GET", url, nil)
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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"context": "PAYMENT",
"subjects": [
"PIX"
],
"logic": [
"AND"
],
"operators": [
{
"operator": "GREATER_THAN",
"valueKind": "single",
"label": "maior que",
"description": "O campo é maior que o valor informado."
}
],
"fields": [
{
"field": "amount",
"type": "integer",
"operators": [
"EQUALS"
],
"viewOperator": [
"EQUALS"
],
"viewType": {
"type": "MONEY",
"prefix": "<string>",
"suffix": "<string>",
"options": [
{
"id": "PIX",
"label": "PIX",
"icon": "<string>"
}
],
"dynamicOptions": "WALLETS"
},
"label": "Valor",
"description": "Valor principal do pagamento. Todo dinheiro é um inteiro em centavos.",
"availability": {
"PIX": "always",
"BOLETO": "always",
"WALLET_TRANSFER_REQUEST": "always"
},
"unit": "centavos",
"enumValues": [
"<string>"
],
"availabilityNote": "<string>",
"dateKind": {
"PIX": "CALENDAR_DATE",
"BOLETO": "CALENDAR_DATE",
"WALLET_TRANSFER_REQUEST": "CALENDAR_DATE"
},
"customField": {
"id": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b",
"slug": "cost-center",
"type": "SELECT",
"required": false,
"entity": "transaction",
"location": "TRANSACTION",
"mask": "<string>"
}
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BUSINESS_POLICY_FORBIDDEN",
"origin": "RULE_ENGINE",
"message": "You do not have permission to manage business policies"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "RULE_ENGINE",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "organizationId",
"message": "Invalid UUID",
"code": "ORGANIZATIONID_UUID"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "CUSTOM_FIELD_CATALOG_UNAVAILABLE",
"origin": "RULE_ENGINE",
"message": "Could not load the organization's custom fields — try again"
}This is the catalog a
PAYMENT policy’s conditions are checked against on create and update: a field that is not listed here (except a card’s custom field, below), an operator a field does not accept, or a value of the wrong type is refused. Build your policy editor from it.
subjects are the payments a PAYMENT policy governs: Pix payments (PIX), boleto payments (BOLETO) and wallet transfer requests (WALLET_TRANSFER_REQUEST). Each field says on which of them it is present (availability); a condition on a field the payment does not carry is false. operators describes every operator and the kind of value it takes; viewOperator and viewType say which operators to offer and which input to render for each field.
The fixed fields come first, followed by one field for each active custom field of the organization on transactions (customFields.<slug>), wallets (wallet.customFields.<slug>), vehicles (vehicle.customFields.<slug>) and users (requester.customFields.<slug>) — text, number, boolean, date and selection fields; file and customer fields cannot be used in a condition. A condition on a card’s custom field (card.customFields.<slug>) is also accepted but not listed: no payment carries a card, so it never matches. Labels and descriptions are in Portuguese.
Any member of the organization can read the catalog.Path Parameters
ID of your realm.
Format: UUID
ID of the organization. Its active custom fields are added to the catalog.
Format: UUID
Response
Successful response
The condition catalog of PAYMENT business policies.
Always PAYMENT.
Available options:
PAYMENT Example:
"PAYMENT"
The payments a PAYMENT policy governs — the values of the subjectType field.
Example: ["PIX","BOLETO","WALLET_TRANSFER_REQUEST"]
The values conditions.logic and each group's logic accept.
Example: ["AND","OR"]
Every operator, with the kind of value it takes.
Show child attributes
Show child attributes
The fields a condition can test: the fixed fields, then one per active custom field of the organization (text, number, boolean, date and selection custom fields only). A condition on a card's custom field is accepted too, but not listed.
Show child attributes
Show child attributes