Payment Customization API reference
The Payment Customization API enables you to rename, reorder, and sort the payment methods available to buyers during checkout.
Extension targets
Anchor link to section titled "Extension targets"The Payment Customization API exposes the following targets:
| Target | Output type | Description |
|---|---|---|
purchase.payment-customization.run |
FunctionRunResult | Outputs the list of operations to apply to payment methods |
The RunInput object is the complete schema that your function can receive as input.
For a list of fields that the Payment Customization API's Input object accepts, refer to Input.
The following example shows an input query:
The following example shows the resulting input to the query:
FunctionRunResult
Anchor link to section titled "FunctionRunResult"The FunctionRunResult object is the expected output for the purchase.payment-customization.run target.
The following function result hides a payment method: