Payment Methods Mutations

See the Queries page for a presentation of this resource.

CreatePaymentMethod

Create a payment method

Parameters

input PaymentMethodInput
Data of the payment method

Example

mutation CreatePaymentMethod($input: PaymentMethodInput!) {
  CreatePaymentMethod(input: $input) {
    id
    label
    active
  }
}

{
  "input": {
    "label": "Cash",
    "active": true
  }
}

Returned data

{
  "data": {
    "CreatePaymentMethod": {
      "id": 100010,
      "label": "Cash",
      "active": true
    }
  }
}

UpdatePaymentMethod

Update a payment method

Parameters

id ID
Id of the payment method

input PaymentMethodInput
Data of the payment method

Example

mutation UpdatePaymentMethod($id: ID!, $input: PaymentMethodInput!) {
  UpdatePaymentMethod(id: $id, input: $input) {
    id
    label
    active
  }
}

{
  "id": 100010,
  "input": {
    "label": "Cash",
    "active": true
  }
}

Returned data

{
  "data": {
    "UpdatePaymentMethod": {
      "id": 100010,
      "label": "Cash",
      "active": true
    }
  }
}

DisablePaymentMethod

Disable a payment method

Parameters

id ID
Id of the payment method

Example

mutation DisablePaymentMethod($id: ID!) {
  DisablePaymentMethod(id: $id) {
    id
    active
  }
}

{
  "id": 100010
}

Returned data

{
  "data": {
    "DisablePaymentMethod": {
      "id": 100010,
      "active": false
    }
  }
}

EnablePaymentMethod

Enable a payment method

Parameters

id ID
Id of the payment method

Example

mutation EnablePaymentMethod($id: ID!) {
  EnablePaymentMethod(id: $id) {
    id
    active
  }
}

{
  "id": 100010
}

Returned data

{
  "data": {
    "EnablePaymentMethod": {
      "id": 100010,
      "active": true
    }
  }
}

DeletePaymentMethod

Delete a payment method

Parameters

id ID
Id of the payment method to delete

Example

mutation DeletePaymentMethod($id: ID!) {
  DeletePaymentMethod(id: $id)
}

{
  "id": 100010
}

Returned data

{
  "data": {
    "DeletePaymentMethod": true
  }
}

PaymentMethodInput data type

id ID
ID for updates.

label String
Name of the Payment Method

integrations [IntegrationInput]
Linked external platforms.