Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-202547455.8 KB
Payment notification

Send payment notification with payment ID, date, and value paid

Sends a payment notification for an order using the payment ID, including the payment date and the value paid.

ℹ️ This endpoint should only be used when the payment was not completed on its creation date or was partially completed (e.g., $50 out of $100). If the payment was made in full on the creation date, use the GET Send payment notification with payment ID endpoint instead.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise, they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
PCI GatewayPayment-NotifyPaymentsPayments Notification

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
Payments NotifierPayments Notification

To learn more about machine authentication at VTEX, see Authentication overview.

post/api/payments/pvt/payments/{paymentId}/payment-notification

Path parameters

paymentIdstring required
Example:B075A551595A43B0AD48DCD8EB481C7F

Payment identification.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

paymentDatestring required

Date when the payment was made, in DD/MM/YYYY format.

valuePaidnumber required

Value that was paid.

Response

OK