JTjtl-software
paymentmethod

Query Payment Methods

Query all payment methods

get/v2/paymentMethods

Request

  • Base URL
    https://scx-sbx.api.jtl-software.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.jtl-cloud.com/oauth2/auth
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesorders.read, invoices.read
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesorders.read, invoices.read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

Returns all payment methods.

idstring uuid
namestring

Name of the payment method.

isStandardboolean

Indicates if the method is the default payment method. There is only one default method and if a new one is enabled, the previous method is no longer the default one.

isActiveboolean

Indicates if the payment method is still active.

Example response

[
  {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.