Settlement

The settlement represents the financial completion process of one or more foreign exchange orders. Through a settlement, the payment and receipt instructions are defined, grouping together compatible operations for joint execution.

Each settlement carries all necessary information to ensure the operation is correctly processed, including monetary values, banking channels, and counterparties.

Main Properties

`type`

Identifies the type of settlement. Currently, the API supports:

STANDARD_SETTLEMENT

`operation`

Indicates the type of operation associated with the settlement. Supported values are:

BUY (Outbound): Purchase of foreign currency or crypto assets.
SELL (Inbound): Sale of foreign currency or crypto assets.

`counterparty`

Contains the details of the counterparty associated with the orders included in the settlement. The counterparty varies according to the operation type.

`paymentAmount`

Amount to be paid by the client to complete the settlement:

For BUY operations: amount is expressed in BRL.
For SELL operations: amount is expressed in the foreign currency or crypto asset being sold.

`receivingAmount`

Amount to be received by the client:

For BUY operations: amount is expressed in the foreign currency or crypto asset being purchased.
For SELL operations: amount is expressed in BRL.

`currentState`

Reflects the current state of the settlement. Each state has specific possible transitions:

Settlement Status Lifecycle

Status	Description	Possible Transitions
`CREATED`	Settlement created and awaiting review by the operations team	`CANCELLED`, `PROVIDER_REVIEW`
`PROVIDER_REVIEW`	Reviewed by the operations team and submitted to the bank	`CANCELLED`, `AWAITING_PAYMENT`
`AWAITING_PAYMENT`	Approved by the bank and awaiting client payment	`CANCELLED`, `AWAITING_SETTLEMENT`
`AWAITING_SETTLEMENT`	Client payment received, awaiting final settlement by the bank	`CANCELLED`, `COMPLETED`
`CANCELLED`	Settlement was cancelled	—
`COMPLETED`	Settlement was successfully completed	—

`sourceBankingChannel`

Banking channel through which the client must make the payment:

For BUY operations: the channel will always be of type TED_PIX.
For SELL operations:
- Fiat currencies: SWIFT
- Crypto assets: CRYPTO_WALLET

Note:

`targetBankingChannel`

Banking channel where the client will receive funds:

For SELL operations: the channel will always be of type TED_PIX.
For BUY operations:
- Fiat currencies: SWIFT
- Crypto assets: CRYPTO_WALLET

Note:
In BUY operations, the banking channel must always be associated with the counterparty linked to the orders.

In SELL operations, the banking channel must always be associated with the company that originated the orders.