Solicitação de extrato do dia atual
Endpoint para solicitar um arquivo de extrato.
Para a solicitação de um extrato, utilizamos o endpoint POST para criar essa requisição e o GET para realizarmos o download do mesmo. Neste documento, iremos tratar do endpoint POST para o dia atual. Este endpoint gerará um ALIAS que será utilizado no momento de realizar o download do arquivo do extrato.
Para realizar a requisição é necessário que um parâmetro seja enviado:
walletId: Para que seja identificada a conta que está sendo requisitada;
A solicitação pode ser feita através do endpoint listado abaixo:
https://kaizen.bt-staging.app/wallet-service/wallets/{walletId}/statements/current-day-statement
Já no corpo da requisição, alguns atributos podem ser enviados como filtros:
operationType: Tipo de operação pelo qual deseja filtrar;
currencyCode: Tipo de moeda pelo qual deseja filtrar;
Exemplo de body
{
"operationType": "{OPERATION_TYPE}", -- opcional
"currencyCode": "{CURRENCY_CODE}", -- opcional
}
Como podemos observar no exemplo de resposta abaixo, o endpoint POST retorna o alias que será utilizado no endpoint GET para realizar o download do mesmo.
Exemplo de resposta
{
"metadata": {
"accountId": "5d3dc30b-758e-4dd7-9344-898df791115b",
"currencyCode": "BRL",
"operationType": "",
"statementType": "LEDGER_EXTRATO_OPERACIONAL"
},
"createdAt": "2023-06-27T14:46:18.697Z",
"alias": "LEDGER_EXTRATO_OPERACIONAL.FROM.2022-09-07.TO.2022-09-07.ACCOUNT.5d3dc30b-758e-4dd7-9344-898df791115b.CUR.BRL.CURRENTDAY",
"status": "pending",
"updatedAt": "2023-07-28T19:35:50.931Z"
}
Updated over 1 year ago