API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

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

Version 2021-07 (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

  • instructions (String!) Required

    Details provided on the order status page.

  • message (String!) Required

    Message provided to the buyer.

Return fields

Version 2021-04 (Latest)

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

Version 2021-01

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

Version 2020-10

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

Version 2020-07

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

Version 2020-04

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

Version 2020-01 (Unsupported)

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

Version 2019-10 (Unsupported)

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

Version 2019-07 (Unsupported)

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

Version 2019-04 (Unsupported)

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