v1

latestOpenAPI 3.0.02026-07-14641139.1 KB
Payment

Send payment notification

Send a payment notification of a given order, by order ID and payment 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.

Request body properties

AttributeTypeDescription
orderIdstringOrder Id
paymentIdstringPayment ID
post/api/orders/pvt/document/{orderId}/payment/{paymentId}/notify-payment

Path parameters

orderIdstring required
Example:70caf3941s6df1

ID of the order.

paymentIdstring required
Example:45hsfg5jkyu1384jdsfgh654sfgj1

ID of the payment.

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.

Response

OK