Pular para o conteúdo principal
PUT
Update payment

📌 Endpoint

PUT /stores/{storeId}/payments/{paymentId} Atualiza envio (shipment) e/ou metadata de um pagamento aprovado.

🔐 Autenticação

  • Rota privada.
  • Requer header Authorization com sua API key e plano ativo.

🧾 Parâmetros de rota


🧍 Body (JSON)


✅ Exemplo de requisição


Snippet padrao (cURL)

Use o exemplo cURL da secao Exemplo de requisicao acima como snippet oficial.

📦 Resposta de sucesso (200)


⚠️ Possíveis erros

  • 400 INVALID_DATA → body/parâmetros inválidos
  • 401 API_KEY_NOT_PROVIDED → header Authorization não enviado
  • 401 INVALID_API_KEY → API key inválida
  • 401 UNAUTHENTICATED → usuário não autenticado
  • 403 USER_DISABLED → usuário desativado ou removido
  • 403 NO_ACTIVE_SUBSCRIPTION → plano inativo ou expirado
  • 403 UPDATE_NOT_ALLOWED → pagamento não está aprovado
  • 404 STORE_NOT_FOUND → loja não encontrada
  • 404 PAYMENT_NOT_FOUND → pagamento não encontrado
  • 429 RATE_LIMIT_EXCEEDED → limite de requisições por minuto do plano excedido
  • 500 INTERNAL_SERVER_ERROR → erro interno
  • 503 SERVICE_UNAVAILABLE → serviço temporariamente indisponível

Autorizações

Authorization
string
header
padrão:YOUR_API_KEY_HERE
obrigatório

Parâmetros de caminho

storeId
string
obrigatório
Required string length: 1 - 50
paymentId
string
obrigatório
Required string length: 1 - 50

Corpo

application/json

Payment fields to update.

shipment
enum<string>
Opções disponíveis:
PENDING,
PREPARING,
SHIPPED,
DELIVERED,
RETURNED,
CANCELLED
metadata
object

Resposta

Update payment.

code
string
obrigatório
Exemplo:

"PAYMENT_UPDATED"

payment
object
obrigatório

Store payment/charge.