Lista de transferências

154
Importante para Integração Direta Para você conseguir efetuar essa integração é obrigatória a leitura sobre "Utilização das APIs" e recomendada a leitura sobre "Instruções Iniciais" e "Client Credentials e Client ID"

Utilize esse endpoint para pegar uma lista de transferência iniciadas. Lembrando que as transferências iniciadas por API precisarão passar por aprovação no aplicativo.

Quais são os requisitos para a utilização desta API?

  • Token: possuir um token de acesso válido é essencial. Caso ainda não tenha gerado um, temos um guia detalhado disponível no tópico Fluxos de Autorização e Autenticação.
  • Transferência: para que a resposta da API seja preenchida, é recomendável que uma transferência tenha sido iniciada anteriormente.
  • Escopo: para a modalidade Parceria Cora, é necessário ter ativado o escopo correto ao solicitar autorização e gerar token de acesso para que sua aplicação possa acessar e interagir com as informações da conta de forma segura e autorizada. É possível consultar mais detalhes sobre o escopo e autorização no tópico Redirecionamento.
Nome do escopoDescrição
transferAPIs de transferência

Bora pro código?

383

Parâmetros da requisição

Parâmetro

Tipo

Descrição

status obrigatório

String

Status do objeto de transferência (TransferStatus)

start\ opcional

String

Data do início do intervalo que será filtrado

end\ opcional

String

Data do fim do intervalo que será filtrado

page\ opcional

int

Número da página

size\ opcional

int

Tamanho da página

Parâmetros de resposta

Parâmetro

Tipo

Descrição

id obrigatório

String

Identificador da transferência

status\ obrigatório

String

Status do objeto de transferência (TransferStatus)

created_at\ obrigatório

String

Data de criação

destination\ obrigatório

Destination

Objeto Destination

holder\ obrigatório

Holder

Objeto Holder

document\ obrigatório

Document

Objeto Document

account_type\ obrigatório

String

Enum de Tipos de Conta

amount\ obrigatório

Int

Valor da transferência em centavos

description\ obrigatório

String

Descrição da operação

code\ obrigatório

String

Código definido por você, pode ser um id do recurso no seu sistema

category\ obrigatório

String

Enumerado de Categorias.
Exemplo: "PAYROLL"

Tipos de Objetos

Objeto Destination

Parâmetro

Tipo

Descrição

bank_code obrigatório

String

Código da instituição financeira.
Exemplo: "403"

account_number\ obrigatório

String

Número da conta bancária com dígito.
Exemplo: "092135"

branch_number\ obrigatório

String

Número da agência.
Exemplo: "7679"

holder\ obrigatório

Holder

Objeto Holder

Objeto Holder

ParâmetroTipoDescrição
name obrigatórioStringNome do titular da conta

Objeto Document

Parâmetro

Tipo

Descrição

identity obrigatório

String

Número do CPF ou CNPJ do titular da conta

type\ opcional

String

CPF ou CNPJ.
Obs: Se não informado, será inferido pela quantidade de dígitos


Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!