Send payment notification

Send a payment notification of a given order, by order ID.

The Notify payment resource is needed to use this API request. This is included in OMS - Full access and IntegrationProfile - Fulfillment Oms, among other default roles available in the Admin. Learn more about the License manager roles and resources.

Learn more about Transaction Details in VTEX Help

Request object has the following properties:

AttributeTypeDescription
orderIdstringOrder Id
paymentIdstringPayment ID

Response codes

200 - Success

400 - Bad request

403 - The credentials are not enabled to access the service

404 - Value not found

429 - Too many requests

Request body example

curl --location --request POST 'https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/payments/{{paymentId}}/payment-notification' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \
--header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}'
Language
Authentication
URL
Click Try It! to start a request and see the response here!