API Reference
Log In
API Reference

Consulta do extrato bancário

Consulta de extrato

Este endpoint retorna todos os movimentos efetivados na conta bancária.

Requisição

GET 'https://apisandbox.delbank.com.br/baas/api/v2/transactions'

curl -X 'GET' \
  'https://apisandbox.delbank.com.br/baas/api/v2/transactions' \
  -H 'accept: */*' \
  -H 'x-delbank-api-key: {{apiKey}}'

Cabeçalhos (Headers)

NomeDescrição
x-delbank-api-keyObrigatório. Chave de API

Parâmetros (query):

NomeTipoDescrição
pagenumberNúmero da página (paginação)
Default: 1
limitnumberQuantidade de itens retornados (paginação)
Default: 10
nsunumberNSU (número sequencial único) da transação
Caso a transação exista, irá retornar somente uma transação
isCreditbooleanUtilize true ou false
Caso seja informado, irá filtrar por transações conforme sua modalidade, seja crédito ou débito. Caso não informado, retornará todas as transações independente da modalidade
typearray|enumTipo de transação
Pode ser informado uma lista de tipos de transação
startDatedateData inicial da criação da transação
Ao aplicar este tipo de filtro, será considerado a data inicial conforme o padrão UTC, ou seja, ao informar 2023-01-01, será retornado as transações que foram criadas a partir de 2023-01-01 03:00:00.000Z
endDatedateData final da criação da transação
Ao aplicar este tipo de filtro, será considerado a data inicial conforme o padrão UTC, ou seja, ao informar 2023-01-01, será retornado as transações que foram criadas até 2023-01-02 02:59:59.000Z
endToEndIdstringEndToEndId da transferência/pagamento no contexto do Pix.
Este tipo filtra visa facilitar a busca pelos pagamentos e recebimentos do Pix
Caso a transação exista, irá retornar somente uma transação

Tipos de transações

TipoDescriçãoModalidade (crédito ou débito)
DEBIT_TRANSFER_INTERNALTransferência enviada (transferência entre contas delbank)Débito
CREDIT_TRANSFER_INTERNALTransferência recebida (transferência entre contas delbank)Crédito
DEBIT_TRANSFER_EXTERNALTED enviadaDébito
CREDIT_TRANSFER_EXTERNALTED recebidaCrédito
DEBIT_PIXPIX enviadoDébito
CREDIT_PIXPIX recebidoCrédito

Exemplos de consulta

# busca de todas as transações
GET 'https://apisandbox.delbank.com.br/baas/api/v1/transactions'

# busca transações somente de crédito
GET 'https://apisandbox.delbank.com.br/baas/api/v1/transactions?isCredit=true'

# busca transação por NSU
GET 'https://apisandbox.delbank.com.br/baas/api/v1/transactions?nsu=999998'

# busca transação por um único tipo de transação
GET 'https://apisandbox.delbank.com.br/baas/api/v1/transactions?type=CREDIT_PIX'

# busca transação por vários tipos de transação
GET 'https://apisandbox.delbank.com.br/baas/api/v1/transactions?type=CREDIT_PIX&type=DEBIT_PIX'

Resposta (response)

[
    {
        "id": "21E3822485720230827144231555972751",
        "nsu": 727646,
        "amount": 5.00,
        "notes": "description",
        "createdAt": "2023-08-27T14:42:34.763Z",
        "type": {
            "name": "CREDIT_PIX",
            "description": "PIX recebido",
            "isCredit": true
        },
        "balance": {
            "balancePrevious": 69696969687968.55,
            "currentBalance": 69696969687973.55
        },
        "proof": {} // generic response
    }
]

🚧

O campo proof, é uma informação genérica que pode ser diferente conforme o tipo de transação. Este campo representa o comprovante da transação

Comprovante do recebimento do Pix

[
    {
        "id": "21E3822485720230827144231555972751",
      	"correlationId": "1f9d63e8-81f6-4636-b862-e2edf4c72d67",
        "nsu": 727646,
        "amount": 5.00,
        "notes": "description",
        "createdAt": "2023-08-27T14:42:34.763Z",
        "type": {
            "name": "CREDIT_PIX",
            "description": "PIX recebido",
            "isCredit": true
        },
        "balance": {
            "balancePrevious": 69696969687968.55,
            "currentBalance": 69696969687973.55
        },
        "proof": {
            "endToEndId": "E3822485720230827144231555972751",
            "status": "PIX_EFFECTIVE",
            "type": "PIX_QR_CODE_DYNAMIC",
            "amount": 5.0,
            "description": "description",
            "payer": {
                "number": "31712",
                "branch": "0001",
                "type": "CURRENT",
                "holder": {
                    "document": "32752023000149",
                    "name": "bxxdbde",
                    "type": "LEGAL"
                },
                "participant": {
                    "name": "DELCRED SCD S.A.",
                    "ispb": "38224857"
                }
            },
            "beneficiary": {
                "number": "31712",
                "branch": "0001",
                "type": "CURRENT",
                "holder": {
                    "document": "32752023000149",
                    "name": "bxxdbde",
                    "type": "LEGAL"
                },
                "participant": {
                    "name": "DELBANK",
                    "ispb": "38224857"
                }
            }
        }
    }
]