Payment Customization

Hide, rename or reorder payment methods at checkout with JavaScript.

A payment customization changes which payment methods are offered at checkout and how they are presented. Your code inspects the cart and returns a list of operations.

var ops = [];

input.paymentMethods.forEach(function (method) {
  if (method.name === 'Cash on Delivery') {
    ops.push({ paymentMethodHide: { paymentMethodId: method.id } });
  }
});

return { operations: ops };

The available payment methods are in input.paymentMethods, each with an id and name.

Operations

Return an array of operations, or { operations: [...] }. Each operation is an object with exactly one of these keys:

Operation	Shape	Effect
Hide	{ paymentMethodHide: { paymentMethodId: '...' } }	Removes the payment method
Rename	{ paymentMethodRename: { paymentMethodId: '...', name: '...' } }	Changes the displayed name
Move	{ paymentMethodMove: { paymentMethodId: '...', index: 0 } }	Moves the method to a position (0 = first)
Order review	{ orderReviewAdd: { ... } }	B2B on Shopify Plus: submits the checkout as a draft order for merchant review
Payment terms	{ paymentTermsSet: { ... } }	Shopify Plus only: net terms, due dates, deposits

Returning an empty array leaves the payment methods unchanged. Operations of any other shape are ignored.

Wallets with logos (Shop Pay, Apple Pay, Google Pay) can be hidden but not renamed or reordered.

Examples

Hide Cash on Delivery above an order value (use the General or Cart family):

var ops = [];
var total = parseFloat(input.cart.cost.totalAmount.amount);

if (total > 500) {
  input.paymentMethods.forEach(function (method) {
    if (method.name === 'Cash on Delivery') {
      ops.push({ paymentMethodHide: { paymentMethodId: method.id } });
    }
  });
}

return { operations: ops };

Put invoice payment first for B2B customers (use a family that selects the customer, e.g. Customer):

var ops = [];
var customer = input.cart.buyerIdentity && input.cart.buyerIdentity.customer;
var isB2B = customer && customer.hasTags && customer.hasTags.some(function (t) { return t.hasTag; });

if (isB2B) {
  input.paymentMethods.forEach(function (method) {
    if (method.name === 'Invoice') {
      ops.push({ paymentMethodMove: { paymentMethodId: method.id, index: 0 } });
    }
  });
}

return { operations: ops };

Notes

• Payment customizations don't use the Run on steps — they apply whenever payment methods are shown.

• If your code throws, no operations are applied and checkout shows the methods unchanged (fail open).

• See also: Cart and Checkout Validation, Delivery Customization.