Atualizar um Pix

Processamento Assíncrono: Este endpoint é processado assincronamente e cria um comando de atualização para o PIX.
A atualização de um PIX é feita assincronamente, ou seja, ao receber a requisição, a nossa API guarda as mudanças que você está solicitando e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Pix é atualizado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento. Veja mais em Listar Comandos de um Pix e Visualizar um Comando.

Eventos de Webhook

Quando a requisição é realizada, um evento pix.update.requested é disparado.
O nosso servidor então começa as tentativas de envio da alteração para a instituição financeira.
Somente depois de confirmado na instituição financeira, aí então o pix é atualizado.
Neste momento o evento pix.update.confirmed é disparado.

O evento pix.db.updated também é disparado na confirmação desta operação.

⚠️

Atenção ao payload de retorno: A resposta da chamada de atualização de um PIX é o payload de um Comando. Dentro do payload do comando tem a chave pix com os dados do PIX em questão.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

UID do Pix

Body Params

Parâmetros para atualização do Pix

float

Quantia

uuid | null

UID da Conta Pix para alterar a chave Pix do recebedor.

Este campo é útil quando você deseja alterar a chave Pix no provedor financeiro.

Importante: Somente são aceitas contas Pix que estejam ativas (status active).

payer
object

Dados do Pagador

date-time

Data e hora de vencimento. Formato iso8601

integer | null

Número de dias ativo após o vencimento

string | null

Mensagem de solicitação ao pagador

additional_info
object | null

Informações adicionais para o pagador

integer | null
enum

Tipo da multa:

  • 0 Sem multa (none)
  • 1 Por valor (amount)
  • 2 Por percentual (percentage)
    No retorno os dados vêm no objeto fine.
Allowed:
float | null

Valor da multa em reais. Obrigatório quando fine_type = amount.

float | null

Percentual da multa (0.0 a 100.0). Obrigatório quando fine_type = percentage.

integer | null
enum

Tipo de juros:

  • 0 Não se aplica / isento (none)
  • 1 Valor diário — dias corridos (daily_amount_calendar)
  • 2 Percentual diário — dias corridos (daily_percentage_calendar)
  • 3 Percentual mensal — dias corridos (monthly_percentage_calendar)
  • 4 Percentual anual — dias corridos (yearly_percentage_calendar)
  • 5 Valor diário — dias úteis (daily_amount_business)
  • 6 Percentual diário — dias úteis (daily_percentage_business)
  • 7 Percentual mensal — dias úteis (monthly_percentage_business)
  • 8 Percentual anual — dias úteis (yearly_percentage_business)
    No retorno os dados vêm no objeto interest.
float | null

Valor diário de juros em reais. Obrigatório quando interest_type for por valor (daily_amount_*).

float | null

Percentual de juros. Obrigatório quando interest_type for por percentual.

integer | null
enum

Tipo de abatimento:

  • 1 Por valor (amount)
  • 2 Por percentual (percentage)
  • 3 Não se aplica — remove o abatimento (none)
    No retorno os dados vêm no objeto reduction.
Allowed:
float | null

Valor do abatimento em reais. Obrigatório quando reduction_type = amount.

float | null

Percentual do abatimento. Obrigatório quando reduction_type = percentage.

integer | null
enum

Tipo de desconto aplicado aos campos discount_* (nulo/ausente = sem desconto):

  • 1 Valor fixo (fixed_amount)
  • 2 Percentual fixo (fixed_percentage)
  • 3 Antecipação por valor — dias corridos (advance_amount_calendar)
  • 4 Antecipação por valor — dias úteis (advance_amount_business)
  • 5 Antecipação por percentual — dias corridos (advance_percentage_calendar)
  • 6 Antecipação por percentual — dias úteis (advance_percentage_business)
    As modalidades de antecipação (36) aceitam apenas uma faixa. No retorno o tipo vem em discounts.type.
Allowed:
float | null

Valor do 1º desconto em reais. Obrigatório quando discount_type for por valor.

float | null

Percentual do 1º desconto. Obrigatório quando discount_type for por percentual.

integer | null

Dias antes do vencimento em que o 1º desconto é válido.

float | null

Valor do 2º desconto em reais.

float | null

Percentual do 2º desconto.

integer | null

Dias antes do vencimento em que o 2º desconto é válido.

float | null

Valor do 3º desconto em reais.

float | null

Percentual do 3º desconto.

integer | null

Dias antes do vencimento em que o 3º desconto é válido.

Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json