Bunne Docs
Liquidações

Consultar uma liquidação.

Retorna uma liquidação com escopo do tenant pelo id público. Exige a permissão settlements:read.

GET
/settlements/{id}

Retorna uma liquidação com escopo do tenant pelo id público. Exige a permissão settlements:read.

Autorização

ApiKeyAuth
AutorizaçãoBearer <token>

Em: header

Parâmetros de caminho

id*string
Match^set_[A-Za-z0-9]+$

Corpo da resposta

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/settlements/set_xxx"
{  "object": "settlement",  "id": "string",  "payout_request_id": "string",  "receivable_assignment_id": "string",  "amount_cents": 1,  "currency": "BRL",  "status": "pending",  "bank_export_format": "ofx",  "bank_export_generated_at": "2019-08-24T14:15:22Z",  "paid_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "request_id": "req_xxx"}

Listar liquidações. GET

Lista as liquidações com escopo do tenant. Exige a permissão settlements:read.

Listar os recebíveis que compõem uma liquidação. GET

Lista os recebíveis (vendas) que compõem uma liquidação, na mesma ordem FIFO em que o repasse os consome. Funciona tanto para liquidação por repasse quanto por cessão/FIDC; devolve página vazia quando a liquidação ainda não tem recebíveis vinculados. Exige a permissão settlements:read. A composição de cada recebível fecha: gross_amount_cents − fee_amount_cents − reserve_held_cents − reversed_amount_cents = amount_cents.