Sign in

v9

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-071292691.1 MB
order-payments

Register a payment for an order

Records a payment against an existing order (a gateway payment or a manual one with method=MANUAL). The order is never marked paid directly: when the captured (PAID) payments cover the total, the order is derived to PAID and a tracking event is appended in the same transaction.

post/api/v1/orders/{orderId}/payments

Path parameters

orderIdstring uuid required
Example:01920000-0000-7000-8000-000000000000

Order identifier (UUID).

Request body

currency'BRL' | 'USD'
installmentsnumber
gatewaystring nullable
gateway_payment_idstring nullable
methodstring required
amountnumber required
status'PENDING' | 'PAID' | 'REJECTED' | 'REFUNDED' required

Response

Payment registered.

idstring required
order_idstring required
order_statusstring required
methodstring required
amountnumber required
currencystring required
installmentsnumber required
statusstring required
gatewaystring nullable required
gateway_payment_idstring nullable required
created_atstring required