Skip to main content
GET
List an organization's spend review policy conditions
A SPEND_REVIEW policy decides what happens when a transaction that already happened — a card purchase, a Pix, a boleto, a transfer, a fee — is sent for review: approve it, deny it, or ask its approvals. This catalog is what its conditions are checked against on create and update: a field that is not listed here, an operator a field does not accept, or a value of the wrong type is refused. There is one subject, TRANSACTION. amount is the transaction’s absolute value in centavos — whether money came in or went out is the separate financialImpactType field — and instrument tells a card transaction from a Pix or a boleto. A field marked conditional exists only on some transactions (the card fields only on card transactions, for example); a condition on a field the transaction does not carry is false. The operators are the same as in the payment catalog. 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>), users (requester.customFields.<slug>) and cards (card.customFields.<slug>) — text, number, boolean, date and selection fields; file and customer fields cannot be used in a condition. Labels and descriptions are in Portuguese. Any member of the organization can read the catalog.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization. Its active custom fields are added to the catalog.

Format: UUID

Response

Successful response

The condition catalog of SPEND_REVIEW business policies.

context
enum<string>
required

Always SPEND_REVIEW.

Available options:
SPEND_REVIEW
Example:

"SPEND_REVIEW"

subjects
string[]
required

What a SPEND_REVIEW policy governs: TRANSACTION.


Example: ["TRANSACTION"]

logic
string[]
required

The values conditions.logic and each group's logic accept.


Example: ["AND","OR"]

operators
object[]
required

Every operator, with the kind of value it takes.

fields
object[]
required

Every field 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).