v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Accounts | Dados

Obtém a lista de transações da conta identificada por accountId

Método para obter a lista de transações da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId mantida pelo cliente na instituição transmissora. É permitida uma consulta máxima que se estenda em 12 meses no passado mais 12 meses no futuro.

PERMISSÃO NECESSÁRIA: ACCOUNTS_TRANSACTIONS_READ

get/baas/v1/open/dat/accounts/{accountId}/transactions

Path parameters

accountIdstring required

Identificador da conta de depósito à vista, de poupança ou de pagamento pré-paga

Query parameters

pageinteger

Número da página que está sendo requisitada (o valor da primeira página é 1)

page-sizeinteger

Quantidade total de registros por páginas

fromBookingDatestring date

Data inicial de filtragem (formato YYYY-MM-DD). Deve ser enviado caso toBookingDate seja informado

toBookingDatestring date

Data final de filtragem (formato YYYY-MM-DD). Deve ser enviado caso fromBookingDate seja informado

creditDebitIndicator'CREDITO' | 'DEBITO'

Indicador do tipo de lançamento (crédito ou débito)

pagination-keystring

Identificador de rechamada para evitar a contagem de chamadas durante a paginação

Response

Dados da lista de transações da conta obtidos com sucesso

Example response

{
  "data": [
    {
      "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
      "completedAuthorisedPaymentType": "TRANSACAO_EFETIVADA",
      "creditDebitType": "DEBITO",
      "transactionName": "Transferencia Enviada Lima Santos",
      "type": "PIX",
      "transactionAmount": {
        "amount": "1000.0400",
        "currency": "BRL"
      },
      "transactionDateTime": "2016-01-29T12:29:03.374Z",
      "partieCnpjCpf": "43908445778",
      "partiePersonType": "PESSOA_NATURAL",
      "partieCompeCode": "001",
      "partieBranchCode": "6272",
      "partieNumber": "67890854360",
      "partieCheckDigit": "4"
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}