Registrar um pagamento em um pedido
POST/v1/orders/:id/payments
Registra um pagamento em um pedido e retorna o pedido com os totais de pagamento recalculados.
Um pedido pode ter vários pagamentos: registre um por método usado pelo cliente, e o pedido é marcado como pago quando eles somarem seu total. Valores acima do total são aceitos e reportados como um pagamento excedente.
Funciona em pedidos criados pela API, feitos pelo cliente na loja virtual (INBOUND) ou realizados pelo comerciante no POS (OUTBOUND). Um pedido de um food app pertence a esse canal e responde 422 order_not_modifiable.
Escopo necessário: orders:write
Request
Responses
- 201
- 401
- 403
- 404
- 422
O pedido com o pagamento aplicado.
Não autenticado — a requisição não possui uma credencial, ou o token Bearer / API key é inválido, expirou ou foi revogado.
Escopo insuficiente — a credencial está autenticada, mas não possui um escopo exigido pelo endpoint.
Não encontrado — nenhum recurso corresponde ao id no caminho (ou ele pertence a outra empresa).
Falha de validação — o corpo da requisição falhou na validação do schema. errors[] lista todos os campos com problema.