Send payment notification with payment ID
Sends a payment notification for an order based on the payment ID.
ℹ If the payment was made on its creation date and for the full amount, use this endpoint. Otherwise, use the alternative endpoint: POST Send payment notification with payment ID, date, and value paid.
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:
| Product | Category | Resource |
|---|---|---|
| PCI Gateway | Payment-NotifyPayments | Payments Notification |
You can create a custom role with that resource or use one of the following predefined roles:
| Role | Resource |
|---|---|
| Payments Notifier | Payments Notification |
To learn more about machine authentication at VTEX, see Authentication overview.
Path parameters
Payment identification.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK