v9

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

Update an order payment status

Updates the status of an existing payment (e.g. confirming a pending PIX as PAID). When the captured payments come to cover the total, the order is derived to PAID and a tracking event is appended in the same transaction.

patch/api/v1/orders/{orderId}/payments/{paymentId}

Path parameters

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

Order identifier (UUID).

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

Order payment identifier (UUID).

Request body

status'PENDING' | 'PAID' | 'REJECTED' | 'REFUNDED' required

Response

Payment status updated.

idstring required
order_idstring required
order_statusstring required
statusstring required
amountnumber required
updated_atstring required