Query Payment Methods

Query all payment methods

GET /v2/paymentMethods

Query Payment Methods

cURL

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/paymentMethods \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/paymentMethods"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/v2/paymentMethods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/paymentMethods",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/paymentMethods"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/v2/paymentMethods")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/paymentMethods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "name": "<string>",
    "isStandard": true,
    "isActive": true
  }
]

Authorizations

oauth2-authorization-codeoauth2-client-credentials

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

200

application/json

Returns all payment methods.

id · string<uuid>

Unique ID to identify a payment method.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

name · string

Name of the payment method.

isStandard · boolean

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

Indicates if the payment method is still active.