O Objeto Transferência


Abaixo vamos trazer os campos de cada tipo de transferência.


Transferência Interna:


Chave Descrição Tipo
id Identificador único da transação, no formato UUID4. String
amount Valor da transação, em centavos de Reais. Integer
fee Taxa da transação, em centavos de Reais. Integer
target Objeto com os dados de conta destino. Veja abaixo seus campos. Object
created_at Horário em que a transação foi criada, em formato ISO8601. Nesse caso nunca será null. String
approved_at Horário em que a transação foi aprovada, em formato ISO8601. Retorna null caso a transação não tenha sido aprovada em nenhum momento. String
rejected_at Horário em que a transação foi rejeitada, em formato ISO8601. Retorna null caso a transação não tenha sido rejeitada em nenhum momento. String
failed_at Horário em que a transação falhou, em formato ISO8601. Retorna null caso a transação nunca tenha falhado. String
failure_reason_code Código do motivo da falha. String
failure_reason_description Descrição do motivo da falha. String
status Status atual da transação, podendo ser um dentre os status à seguir: CREATED, REJECTED, EXPIRED, APPROVED, SCHEDULED, FAILED, FINISHED, CANCELLED. String
description Descrição que foi adicionada durante a criação da transação. Retornará "" caso não tenha sido preenchido. Campo com tamanho máximo de 140 caracteres. String
approved_by Identificador único do usuário que aprovou a transação, no formato user:UUID4. Retorna null caso não tenha sido aprovada em nenhum momento. String
created_by Identificador único do usuário que criou a transação, no formato user:UUID4. Neste caso nunca irá retornar null. String
rejected_by Identificador único do usuário que rejeitou a transação, no formato user:UUID4. Retorna null caso não tenha sido rejeitada em nenhum momento. String
approval_expired_at Horário em que a transação expirou, em formato ISO8601. Retorna null caso a transação esteja aguardando aprovação ou já tenha sido aprovada em algum momento. String
cancelled_at Horário em que um pagamento agendado foi cancelado, em formato ISO8601. Retorna null caso não haja cancelamento. String
finished_at Horário em que a transação foi finalizada, em formato ISO8601. Retorna null caso a transação não tenha sido finalizada. String
scheduled_to Data na qual a transferência será executada. Retornará null caso não haja agendamento. String

Transferência Externa:


Chave Descrição Tipo
id Identificador único da transação, no formato UUID4. String
amount Valor da transação, em centavos de Reais. Integer
fee Taxa da transação, em centavos de Reais. Integer
target Objeto com os dados de conta destino. Veja abaixo seus campos. Veja seus campos aqui Object
created_at Horário em que a transação foi criada, em formato ISO8601. Nesse caso nunca será null. String
approved_at Horário em que a transação foi aprovada, em formato ISO8601. Retorna null caso a transação não tenha sido aprovada em nenhum momento. String
rejected_at Horário em que a transação foi rejeitada, em formato ISO8601. Retorna null caso a transação não tenha sido rejeitada em nenhum momento. String
failed_at Horário em que a transação falhou, em formato ISO8601. Retorna null caso a transação nunca tenha falhado. String
failure_reason_code Código do motivo da falha. String
failure_reason_description Descrição do motivo da falha. String
status Status atual da transação, podendo ser um dentre os status à seguir: CREATED, REJECTED, EXPIRED, APPROVED, SCHEDULED, FAILED, FINISHED, CANCELLED. String
approved_by Identificador único do usuário que aprovou a transação, no formato user:UUID4. Retorna null caso não tenha sido aprovada em nenhum momento. String
created_by Identificador único do usuário que criou a transação, no formato user:UUID4. Neste caso nunca irá retornar null. String
rejected_by Identificador único do usuário que rejeitou a transação, no formato user:UUID4. Retorna null caso não tenha sido rejeitada em nenhum momento. String
approval_expired_at Horário em que a transação expirou, em formato ISO8601. Retorna null caso a transação esteja aguardando aprovação ou já tenha sido aprovada em algum momento. String
cancelled_at Horário em que um pagamento agendado foi cancelado, em formato ISO8601. Retorna null caso não haja cancelamento. String
finished_at Horário em que a transação foi finalizada, em formato ISO8601. Retorna null caso a transação não tenha sido finalizada. String
delayed_to_next_business_day Caso a transação seja feita fora do horário, será agendada para o póximo dia útil. Caso esse agendamento ocorra, retorna true, caso contrário, retorna false. Boolean
refund_reason_code Código do reembolso. Retorna null caso não haja reembolso. String
refund_reason_description Descrição do motivo do reembolso. Retorna null caso não haja reembolso. String
scheduled_to_effective Data na qual a TED será executada. Pode divergir da data solicitada quando esta for um dia não útil. Retornará null caso não haja agendamento. String
scheduled_to_requested Data para a qual o agendamento da TED foi solicitado. Retornará null caso não haja agendamento. String

Campos do objeto target:

Chave Descrição Tipo
account Objeto que representa a conta destino da transferência. Veja os campos desse objeto abaixo. Object
entity Objeto que contem os dados do indivíduo ou companhia responsável pela conta. Veja os campos desse objeto abaixo. Object

Campos do objeto account:

Chave Descrição Tipo
account_code Número da conta bancária. String
branch_code Número da agência da conta. Padrão: ^\d{1,4}$ , não deve ser informado o dígito verificador.
Apenas para transferência externa.		 String
institution_ispb Código ISPB da instituição responsável pela conta. Existe uma lista completa relacionando as instituições e seus respectivos códigos neste link.
Apenas para transferência externa.		 String
institution_name Nome da instituição responsável pela conta.
Apenas para transferência externa.		 String
institution_number_code Código numérico da instituição responsável pela conta.
Apenas para transferência externa.		 String
account_type Código que identifica o tipo de conta. Os valores possíveis são:
CC - Conta Corrente, CD - Conta de Depósito, CG - Conta garantida, CI - Conta de Investimento, PG - Conta de Pagamento, PP - Poupança.
Apenas para transferência externa.		 String

Campos do objeto entity:

Chave Descrição Tipo
name Nome do proprietário da conta. String
document Número do documento sem pontos da dona da conta alvo. Apenas para transferência externa. String
document_type Tipo do documento da dona da conta alvo. Pode ser cpf ou cnpj. Utilizamos esse valor para distinguir o tipo de entidade da proprietária da conta entre pessoa física e pessoa jurídica. Apenas para transferência externa. String

A criação de transferências internas e externas estão sujeitas a um limite de "amount": 999999999999999999.
Observe que o usuário não é limitado de nenhuma forma prática por esse valor.

Última modificação: 01.01.0001