Skip to main content
GET
/
v1
/
paymentMethods
Query Payment Methods
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/paymentMethods \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "Id": 123,
    "Name": "<string>",
    "IsStandard": true,
    "IsActive": true
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

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

​
x-companyid
string

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

Response

Returns all payment methods.

​
Id
integer<int32>
required

Unique ID to identify a payment method.

​
Name
string
required

Name of the payment method.

​
IsStandard
boolean
required

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.

​
IsActive
boolean
required

Indicates if the payment method is still active.