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
Request
path Parameters
orderId
required
string

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

paymentId
required
string

The unique identifier of the order payment base to be removed

header Parameters
Connect-Region-Code
string

Region Code

Responses
204

Payment removed.

400

Payment cannot be removed.

delete/ocapi/v1/orders/{orderId}/payments/{paymentId}
Request samples