get http://{{auth_server_host}}/banking/originator/beneficiary-accounts
Esse endpoint permite a listagem das contas beneficiárias cadastradas para o Originador. É possível realizar paginação para a consulta de todos os registros.
Parâmetros da URL
page(integer): O número da página para paginação.
size(integer): O número de itens por página.
Resposta
Se a requisição for processada com sucesso será retornado um status 200 e um JSON com os seguintes campos:
content(object): Objeto contendo o resultado com as linhas de crédito que atendam aos filtros aplicados.
total_pages(int): Quantidade de páginas para paginação.
total_elements(int): Quantidade total de registros encontrados.
has_next(boolean): Flag para indicar se terá a próxima página para paginação.
Objeto "content"
id: ID de cadastro da conta.
external_bank_account: Objeto contendo os dados da conta bancária.
created_at: Data de cadastro.
updated_at: Data da última atualização do registro.
Objeto "beneficiary_account"
registered_account_id: ID da conta registrada.
holder -> name: Nome da carteira.
holder -> taxpayer_id: Número do documento do operador da carteira.
external_bank_account: Objeto contendo os dados da conta bancária para depósito.
Objeto "external_bank_account"
bank_code(string): Código do banco.
bank_account(string): Número da conta
bank_account_digit(string): Dígito do número da conta.
bank_branch(string): Número da agência.
bank_account_type(string): Tipo da conta bancária.
ispb_code(string): Código ISPB relacionado ao banco da conta informada.
pix(object): Objeto contendo os dados de uma chave PIX.
pix -> key(string): Chave PIX.
pix -> key_type(string): Tipo da chave PIX. Valores aceitos: ALEATORY_KEY, EMAIL, PHONE_NUMBER, TAXPAYER_ID
baas -> account_number: Número da conta bancária no baas
Exemplo de JSON:
{
"content": [
{
"id": "<uuid>",
"external_bank_account": {
"bank_account": "<string>",
"bank_account_digit": "<string>",
"bank_branch": "<string>",
"bank_code": "<string>",
"bank_account_type": "SVGS",
"ispb_code": "<string>"
},
"description": "<string>",
"holder": {
"name": "<string>",
"taxpayer_id": "<string>"
},
"default_account": "<boolean>",
"enabled": "<boolean>",
"pix": {
"key": "<string>",
"key_type": "TAXPAYER_ID"
},
"created_at": "<dateTime>",
"updated_at": "<dateTime>",
"version": "<integer>"
},
{
"id": "<uuid>",
"external_bank_account": {
"bank_account": "<string>",
"bank_account_digit": "<string>",
"bank_branch": "<string>",
"bank_code": "<string>",
"bank_account_type": "CACC",
"ispb_code": "<string>"
},
"description": "<string>",
"holder": {
"name": "<string>",
"taxpayer_id": "<string>"
},
"default_account": "<boolean>",
"enabled": "<boolean>",
"pix": {
"key": "<string>",
"key_type": "EMAIL"
},
"created_at": "<dateTime>",
"updated_at": "<dateTime>",
"version": "<integer>"
}
],
"total_pages": "<integer>",
"total_elements": "<long>",
"has_next": "<boolean>"
}