IntroduçãoReferência de APICentral de AjudaObter SuporteStatus page
Referência

Depósito

Confira os eventos acionados por depósitos e os dados enviados.

Mudança de estado do depósito via PIX

Acionado sempre que o status de um depósito recebido via PIX é alterado.

ParâmetroDescriçãoExemplo
eventTipo de evento relacionado ao depósitodeposit.pix_status_changed
deposit_idIdentificador único do depósitoB123F45G6HI789JKL012MNO345P678QR
statusStatus do depósitoaccepted
account_idIdentificador da conta67890ABCDEF1234567890GHIJKLMN456
amount_centsValor do depósito em centavos1000
deposit_typeTipo de depósitoqrcode
sender_ispbCódigo ISPB do banco remetente12345678
sender_compeCódigo COMPE do banco remetente001
sender_bank_nameNome do banco remetenteBanco Alpha
sender_bank_branchAgência do banco remetente1234
sender_bank_accountConta do banco remetente987654321
sender_nameNome do remetenteJoão Silva Oliveira
sender_cpf_cnpjCPF ou CNPJ do remetente12345678901
receiver_ispbCódigo ISPB do banco destinatário87654321
receiver_compeCódigo COMPE do banco destinatário237
receiver_bank_nameNome do banco destinatárioBanco Beta S.A.
receiver_bank_branchAgência do banco destinatário4321
receiver_bank_accountConta do banco destinatário123456789
receiver_bank_account_digitDígito verificador da conta9
receiver_nameNome do destinatárioBeta Instituição de Pagamento S.A.
receiver_cpf_cnpjCPF ou CNPJ do destinatário98765432000112
transfered_atData e hora da transferência2024-12-16T12:00:00.000Z
descriptionDescrição do depósitoTransferência via PIX
statement_identifierIdentificador do extratoA123456789202412161200ZXY9WUVT
accepted_atData e hora da aceitação2024-12-16T12:01:00.000Z

Mudança de estado do depósito via TED

Acionado sempre que o status de um depósito recebido via TED é alterado.

ParâmetroDescriçãoExemplo
data[event]Evento relacionado ao depósitodeposit.ted_status_changed
data[deposit_id]ID do depósitoDEPOSIT123456789
data[status]Status do depósitocompleted
data[account_id]ID da conta associada ao depósitoACC987654321
data[amount_cents]Valor do depósito em centavos250000
data[deposit_type]Tipo de depósitoted
data[sender_ispb]ISPB do banco remetente98765432
data[sender_compe]Código COMPE do banco remetente123
data[sender_bank_name]Nome do banco remetenteBanco Exemplo S.A.
data[sender_bank_branch]Agência do banco remetente0001
data[sender_bank_account]Conta bancária do remetente0123456
data[sender_name]Nome do remetenteJoão da Silva
data[sender_cpf_cnpj]CPF ou CNPJ do remetente12345678901
data[receiver_ispb]ISPB do banco receptor15111975
data[receiver_compe]Código COMPE do banco receptor401
data[receiver_bank_name]Nome do banco receptorIUGU IP S.A.
data[receiver_bank_branch]Agência do banco receptor0002
data[receiver_bank_account]Conta bancária do receptor6543210
data[receiver_bank_account_digit]Dígito da conta bancária do receptor5
data[receiver_name]Nome do receptorEmpresa Exemplo Ltda
data[receiver_cpf_cnpj]CPF ou CNPJ do receptor98765432000109
data[transfered_at]Data e hora da transferência2024-11-13T12:45:00.000Z
data[description]Descrição da transferênciaPagamento de serviços
data[statement_identifier]Identificador do extratoE202411132045ABCDEF12345678