Skip to main content
Use PATCH /api/v1/orders/{externalId} quando o status ou dados permitidos de um pedido mudarem.

Status aceitos

  • pending
  • paid
  • refused
  • refunded
  • chargedback
A API normaliza aliases comuns de gateways. Exemplos:
  • approved, completed, concluido, pago -> paid
  • waiting_payment, pendente -> pending
  • rejected, failed, cancelled, recusado -> refused
  • refund, reembolsado, estornado -> refunded
  • chargeback, charged_back, dispute -> chargedback

Transições válidas

refused e chargedback são terminais.

Payload para marcar como pago

Campos permitidos no PATCH

  • status
  • paidAt
  • refundedAt
  • chargedbackAt
  • isTest
  • amounts
  • customer
  • tracking
  • trackingExtras
  • metadata
Campos de criação como externalId, platform, paymentMethod, createdAt, products e fees não são atualizados por PATCH.

Exemplo curl

Erros

  • ORDER_NOT_FOUND: pedido não existe no dashboard autenticado.
  • INVALID_STATUS_TRANSITION: transição de status inválida.
  • VALIDATION_FAILED: payload inválido.
  • UNAUTHORIZED ou TOKEN_REVOKED: problema no token.