payments

Query payments — supports a `where` predicate, `sort`, and `limit`/`offset` paging.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the payments action (under Payments).
Fill in the fields below, then reference the result from later steps as {{payments.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query Payments($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  payments(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      key
      customerRef {
        typeId
        id
      }
      customer {
        id
        customerNumber
        email
        addresses
        defaultShippingAddressId
        defaultBillingAddressId
        shippingAddressIds
        billingAddressIds
        isEmailVerified
        customerGroupRef
        externalId
        key
        authenticationMode
        firstName
        lastName
        middleName
        title
        locale
        salutation
        dateOfBirth
        companyName
        vatId
        password
        customerGroup
        defaultShippingAddress
        defaultBillingAddress
        shippingAddresses
        billingAddresses
        storesRef
        stores
        customerGroupAssignments
        custom
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      anonymousId
      interfaceId
      amountPlanned {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      paymentMethodInfo {
        paymentInterface
        method
        nameAllLocales
        token
        interfaceAccount
        custom
      }
      paymentStatus {
        interfaceCode
        interfaceText
        stateRef
        state
      }
      transactions {
        id
        timestamp
        type
        amount
        interactionId
        state
        custom
        interfaceId
      }
      custom {
        typeRef
        type
      }
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

wherestring

sortarray<string>

limitnumber

offsetnumber

json

{
  "where": "string",
  "sort": [
    "string"
  ],
  "limit": 0,
  "offset": 0
}

Response

Read the result with {{payments.response.data.data.payments}}. If the API returns errors, the step fails and they are at {{payments.response.data.errors}}.

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

keyobject

customerRefobject

customerobject

anonymousIdobject

interfaceIdobject

amountPlannedobject

paymentMethodInfoobject

paymentStatusobject

transactionsobject

customobject

idobject

versionobject

createdAtobject

lastModifiedAtobject

createdByobject

lastModifiedByobject

Need more? See the Commercetools guide for connection setup and behaviour shared by every action.

Was this page helpful?