customPaymentMethodUpdate mutation

Version unstable

Updates a custom payment method.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
id ( ID! ) required

The id of the custom payment method.

paymentMethod ( CustomPaymentMethodInput! ) required

Message and instructions for the custom payment method.

CustomPaymentMethodInput fields

  • instructions (String!) Required

    Details provided on the order status page.

  • message (String!) Required

    Message provided to the buyer.

Return fields

  • customPaymentMethod (CustomPaymentMethod)

    The updated custom payment method.

  • userErrors ([UserError!]!)

    List of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Updates a custom payment method.

Required access

write_payment_settings access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
id ( ID! ) required

The id of the custom payment method.

paymentMethod ( CustomPaymentMethodInput! ) required

Message and instructions for the custom payment method.

CustomPaymentMethodInput fields