Payment Methods Queries

Query configured payment methods.

Available queries

PaymentMethod - Returns a single payment method based on the id provided

GraphQL

query {
  PaymentInformation (id: 100012) {
    label
  }
}

PaymentMethods - Returns a list of payment methods based on the filter define

GraphQL

query {
  PaymentMethods {
    data {
      label
    }
  }
}

---

Available fields

Field	Type	Description
id	Int	Unique identifier of the payment method.
label	String	Name of the payment method.
active	Boolean	If true, the payment method is active.
integrations	[Integration]	Linked external platforms.

---

Filters

You can create filters based on following fields

label
Example:{ "column" : "LABEL", "operator" : "EQ", "value" : "EUR" }

active
Example:{ "column": "ACTIVE", "operator": "EQ", "value": true }

---

Sorting

You can sort data based on following fields : id, label, default, active

GraphQL

query PaymentMethods(
  $where: QueryPaymentMethodsWhereWhereConditions, 
) {
  PaymentMethods(
    orderBy: [{column: LABEL, order: ASC}]
    where: $where
  ) {
    paginatorInfo {
      total
    }
    data {
      id
      label
      active
    }
  }
}

Variables (JSON)

{
  "where": {
    "AND": [
      {
        "column": "ACTIVE",
        "operator": "EQ",
        "value": true
      }
    ]
  }
}

Example of data returned

JSON

{
  "data": {
    "PaymentMethods": {
      "paginatorInfo": {
        "total": 1
      },
      "data": [
        {
          "id": 100002,
          "label": "Cash",
          "active": true,
        }
      ]
    }
  }
}