Skip to main content
PATCH
Funcionalidade em beta. Contrato em proposta, sujeito a mudanças. Veja o guia Acompanhar repasses.
Atualiza um repasse (payout) que ainda não foi executado. Com esta rota, o gestor do marketplace pode:
  • cancelar o repasse (CANCEL), por exemplo, quando o pedido é devolvido;
  • pausar o repasse (HOLD), por exemplo, quando há uma disputa sobre a venda;
  • liberar um repasse pausado (RELEASE), quando a disputa é resolvida;
  • mudar a data do repasse (paymentDate), sozinha ou junto com uma ação.
Enquanto o repasse não é executado, nenhum dinheiro sai da conta de recebimento. Por isso, cancelar ou pausar não gera estorno: o valor apenas permanece na conta de recebimento.

O que cada atualização faz

Você pode enviar paymentDate junto com HOLD ou RELEASE. Por exemplo, para liberar um repasse pausado com uma nova data, envie RELEASE e o novo paymentDate. Com CANCEL, o paymentDate não é aceito. Repasses em PROCESSING, SUCCESS, CANCELED ou REFUNDED não podem ser atualizados.
Em uma disputa em que só parte da venda é desfeita, pause o repasse com HOLD e depois use Devolver parte de um repasse para devolver essa parte ao cliente final. O valor devolvido é descontado do repasse. Por fim, libere o repasse com RELEASE.
Um repasse sem data futura é executado logo após o recebimento, então fica em PENDING por pouquíssimo tempo. Para ter tempo de cancelar ou pausar um repasse, agende-o com paymentDate na instrução de split do QR Code.

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

Informe paymentDate, action ou os dois.
string
Nova data do repasse, no formato YYYY-MM-DD. Deve ser uma data futura (a partir de amanhã). Para executar um repasse agendado hoje, use Reprocessar repasse. Não pode ser usado com CANCEL.
object
Ação sobre o repasse.

Response

Retorna o repasse atualizado, na mesma estrutura descrita em Listar repasses. Conforme a ação:
  • CANCEL: status.name igual a CANCELED e cancellationDetails preenchido (canceledBy, reason e canceledAt).
  • HOLD: status.name igual a HOLDING e holdDetails preenchido (heldBy, reason e heldAt).
  • RELEASE: status.name igual a SCHEDULED e holdDetails completado com releasedBy, releaseReason e releasedAt.

Erros