Skip to main content
POST
Funcionalidade em beta. Contrato em proposta, sujeito a mudanças. Veja o guia Acompanhar repasses.
Cria uma devolução (refund) de parte do valor de um repasse (payout). A devolução faz duas coisas:
  1. Envia um Pix de devolução ao cliente final (o pagador), vinculado ao Pix original da ordem de recebimento com split. O valor sai da conta de recebimento.
  2. Desconta o valor devolvido do repasse: o amount do repasse diminui e o refundedAmount aumenta.
Use quando uma venda precisa ser desfeita em parte antes de o beneficiário receber. Por exemplo, em uma disputa em que o cliente final devolve um dos produtos do pedido.

Quando é possível devolver

Quando a soma das devoluções concluídas chega ao valor original do repasse, o repasse vai para REFUNDED e não é mais executado. Enquanto sobra algum valor, o repasse continua no status em que estava e é executado normalmente, com o valor restante.
Depois que o repasse é concluído (SUCCESS), não é possível devolver por esta rota, porque o dinheiro já está na conta do beneficiário. Nesse caso, a conta de recebimento ainda pode devolver o Pix original ao cliente final, mas o valor sai do caixa do marketplace, sem desconto no repasse.
Em uma disputa, pause o repasse com HOLD antes de negociar com o cliente final. Assim o repasse não é executado na data prevista enquanto você decide quanto devolver.

Headers

string
required
Sua API key.
string
required
Número da conta de recebimento.

Path params

string
required
Identificador do repasse (id), obtido em Listar repasses ou em Consultar ordem de recebimento com split.

Body

number
required
Valor a devolver, em reais. Deve ser maior que zero e no máximo igual ao amount atual do repasse.
string
Motivo da devolução. Até 200 caracteres. Também é enviado como descrição do Pix de devolução.
string
Nome ou identificação de quem pediu a devolução, por exemplo, o usuário ou a área da sua plataforma. Até 50 caracteres. Se não for informado, a API registra Não informado.

Response

Retorna 201 Created com a devolução criada, em PROCESSING. O Pix de devolução é processado de forma assíncrona: acompanhe o resultado em Listar devoluções de um repasse. O valor é descontado do repasse assim que a devolução é criada. Se a devolução terminar em ERROR, o valor volta para o amount do repasse.
string
Identificador da devolução.
string
Identificador do repasse.
number
Valor devolvido, em reais.
object
Status da devolução, como enum (name, description e value). name: PROCESSING (Pix de devolução enviado, aguardando confirmação), SUCCESS (valor devolvido ao cliente final) ou ERROR (devolução não concluída; o valor volta para o repasse).
string
Motivo informado.
string
Quem pediu a devolução.
string
Id da transação de devolução no extrato da conta de recebimento.
string
Identificador do Pix de devolução. Pode vir null enquanto a devolução está em PROCESSING.
string
Motivo da falha, quando o status é ERROR.
string
Data e hora da criação da devolução, em ISO 8601.
string
Data e hora da última mudança de status, em ISO 8601.

Erros