Execution

To perform a transaction that will follow the accounting movements mapped in the Execution Rules, the POST /execution method must be used.

The user must inform the parameters:

Parameter
Description

transaction_type

The type of the transaction, as mapped in the Execution Rules

currency

The currency of the transaction

amount

The main amount of the transaction

param_account_1

The ID of the account used as parameter 1 of the transaction. Not mandatory

param_account_2

The ID of the account used as parameter 2 of the transaction. Not mandatory

settled_at

The date for the transaction to be accounted in further reports. If this parameter is not informed, the system will consider the date when the transaction was created.

external_id

User value set for later conciliation

Example of execution creation:

POST /execution

{
  "transaction_type": "pix_out",
  "currency": "brl",
  "amount": 10000,
  "param_account_1": "2874d9c5-e919-8715-b3eb-4ee3440a2fe3",
  "param_account_2": "bb2b0e40-2308-5330-bb6a-6de434493f0e",
  "settled_at": "2023-06-01",
  "external_id": "our id 1234",
  "custom_entries": [
    {
      "entry_type": "pix_out_fee",
      "decimals": 2,
      "amount_type": "value",
      "amount": 250
    }
  ],
  "metadata": {
    "key": "value"  
  }
}

Response Example:

{
  "id": "96296a5c-0cf4-4025-dbc4-1a53f0a3afc6"
}

Last updated