Orders
Payments

Removes an order payment base from an in progress order base

Only order gift card payment and order member balance payment entities can be removed at this time.

Licenses Required

  • Vista.Ocapi
delete/ocapi/v1/orders/{orderId}/payments/{paymentId}

Request

Path parameters

orderIdstring required

The unique identifier of the in progress order base that the payment will be removed from

paymentIdstring required

The unique identifier of the order payment base to be removed

Headers

Connect-Region-Codestring

Region Code

Response

Payment removed.

Changes

No recorded changes to this operation across all 5 revisions of this API.