Extrato (Statement)

Consultar extrato

post

/report/statement

Consulta as transações realizadas pelo seller

Authorizations

X-Token-ApistringRequired

Token de autenticação para acesso à API

Body

É preciso enviar uma das combinações abaixo para realizar a consulta:

1. idSeller, executionDateInitial, executionDateFinal
2. cnpj, executionDateInitial, executionDateFinal
3. uuid_order
4. uuid_charge

idSellerstringOptional

Id do seller que deseja-se consultar

cnpjstringOptional

CNPJ do seller que deseja-se consultar

executionDateInitialstring · dateOptional

Data inicial do período consultado

executionDateFinalstring · dateOptional

Data final do período consultado

uuid_orderstring · uuidOptional

UUID do pedido

uuid_chargestring · uuidOptional

UUID da cobrança

Responses

200

Consulta realizada com sucesso

application/json

uuidstring · uuidOptional

UUID da statement

Example: 8a3f5c2e-1b4d-4e9a-b7c1-3d6f9e2a1c5b

execution_datestring · dateOptional

Data de execução

charge_paid_datestring · date-timeOptional

Data de pagamento da cobrança

uuid_chargestring · uuidOptional

UUID da cobrança

operacaostring · enumOptional

Tipo de operação

Possible values:

payment_methodstringOptional

Método de pagamento utilizado

entrada_brutanumber · doubleOptional

Valor bruto de entrada

saida_brutanumber · doubleOptional

Valor bruto de saída

entrada_liquidanumber · doubleOptional

Valor líquido de entrada

saida_liquidanumber · doubleOptional

Valor líquido de saída

taxa_operacaostringOptional

Taxa aplicada na operação

bandeirastringOptional

Bandeira do cartão

400

Erro na requisição

application/json

401

Erro de autenticação

application/json

403

Acesso não autorizado

application/json

post/report/statement

POST /v2/report/statement HTTP/1.1
Host: api.barte.com
X-Token-Api: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "idSeller": "text",
  "cnpj": "text",
  "executionDateInitial": "2026-01-01",
  "executionDateFinal": "2026-01-01",
  "uuid_order": "123e4567-e89b-12d3-a456-426614174000",
  "uuid_charge": "123e4567-e89b-12d3-a456-426614174000"
}

[
  {
    "uuid": "8a3f5c2e-1b4d-4e9a-b7c1-3d6f9e2a1c5b",
    "execution_date": "2026-01-01",
    "charge_paid_date": "2026-01-01T00:00:00.000Z",
    "uuid_charge": "123e4567-e89b-12d3-a456-426614174000",
    "operacao": "ESTORNO",
    "payment_method": "text",
    "entrada_bruta": 1,
    "saida_bruta": 1,
    "entrada_liquida": 1,
    "saida_liquida": 1,
    "taxa_operacao": "text",
    "bandeira": "text"
  }
]