Put v1panelsettingsproviders

cURL

curl --request PUT \
  --url https://api.example.com/v1/panel/settings/providers/{provider} \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <x-csrf-token>' \
  --data '
{
  "enabled": true,
  "displayOrder": 123,
  "merchantId": "<string>",
  "credentials": "<string>",
  "webhookSecret": "<string>"
}
'

import requests

url = "https://api.example.com/v1/panel/settings/providers/{provider}"

payload = {
    "enabled": True,
    "displayOrder": 123,
    "merchantId": "<string>",
    "credentials": "<string>",
    "webhookSecret": "<string>"
}
headers = {
    "X-CSRF-Token": "<x-csrf-token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    displayOrder: 123,
    merchantId: '<string>',
    credentials: '<string>',
    webhookSecret: '<string>'
  })
};

fetch('https://api.example.com/v1/panel/settings/providers/{provider}', 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.example.com/v1/panel/settings/providers/{provider}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'displayOrder' => 123,
    'merchantId' => '<string>',
    'credentials' => '<string>',
    'webhookSecret' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-CSRF-Token: <x-csrf-token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v1/panel/settings/providers/{provider}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"displayOrder\": 123,\n  \"merchantId\": \"<string>\",\n  \"credentials\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/v1/panel/settings/providers/{provider}")
  .header("X-CSRF-Token", "<x-csrf-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"displayOrder\": 123,\n  \"merchantId\": \"<string>\",\n  \"credentials\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/panel/settings/providers/{provider}")

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

request = Net::HTTP::Put.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"displayOrder\": 123,\n  \"merchantId\": \"<string>\",\n  \"credentials\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}"

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

{
  "provider": "<string>",
  "merchantId": "<string>",
  "enabled": true,
  "displayOrder": 123,
  "credentialsSet": true,
  "webhookSecretSet": true,
  "adapterRecurring": true,
  "recurringEnabled": true,
  "recurringTestStatus": "untested",
  "connectionStatus": "unknown",
  "webhookStatus": "unknown",
  "updatedAt": "2023-11-07T05:31:56Z",
  "recurringTestedAt": "2023-11-07T05:31:56Z",
  "connectionCheckedAt": "2023-11-07T05:31:56Z",
  "connectionErrorCode": "<string>",
  "webhookLastEventAt": "2023-11-07T05:31:56Z",
  "webhookLastErrorCode": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

PUT

panel

settings

providers

{provider}

cURL

curl --request PUT \
  --url https://api.example.com/v1/panel/settings/providers/{provider} \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <x-csrf-token>' \
  --data '
{
  "enabled": true,
  "displayOrder": 123,
  "merchantId": "<string>",
  "credentials": "<string>",
  "webhookSecret": "<string>"
}
'

import requests

url = "https://api.example.com/v1/panel/settings/providers/{provider}"

payload = {
    "enabled": True,
    "displayOrder": 123,
    "merchantId": "<string>",
    "credentials": "<string>",
    "webhookSecret": "<string>"
}
headers = {
    "X-CSRF-Token": "<x-csrf-token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    displayOrder: 123,
    merchantId: '<string>',
    credentials: '<string>',
    webhookSecret: '<string>'
  })
};

fetch('https://api.example.com/v1/panel/settings/providers/{provider}', 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.example.com/v1/panel/settings/providers/{provider}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'displayOrder' => 123,
    'merchantId' => '<string>',
    'credentials' => '<string>',
    'webhookSecret' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-CSRF-Token: <x-csrf-token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v1/panel/settings/providers/{provider}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"displayOrder\": 123,\n  \"merchantId\": \"<string>\",\n  \"credentials\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/v1/panel/settings/providers/{provider}")
  .header("X-CSRF-Token", "<x-csrf-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"displayOrder\": 123,\n  \"merchantId\": \"<string>\",\n  \"credentials\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/panel/settings/providers/{provider}")

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

request = Net::HTTP::Put.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"displayOrder\": 123,\n  \"merchantId\": \"<string>\",\n  \"credentials\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}"

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

{
  "provider": "<string>",
  "merchantId": "<string>",
  "enabled": true,
  "displayOrder": 123,
  "credentialsSet": true,
  "webhookSecretSet": true,
  "adapterRecurring": true,
  "recurringEnabled": true,
  "recurringTestStatus": "untested",
  "connectionStatus": "unknown",
  "webhookStatus": "unknown",
  "updatedAt": "2023-11-07T05:31:56Z",
  "recurringTestedAt": "2023-11-07T05:31:56Z",
  "connectionCheckedAt": "2023-11-07T05:31:56Z",
  "connectionErrorCode": "<string>",
  "webhookLastEventAt": "2023-11-07T05:31:56Z",
  "webhookLastErrorCode": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

Headers

X-CSRF-Token

string

required

Echoes the token from the current session. Required on every unsafe method.

Path Parameters

provider

string

required

Body

application/json

enabled

boolean

required

displayOrder

integer

required

merchantId

string

Empty for an installation with a single merchant account.

credentials

string | null

Omit or send null to keep the stored credential.

webhookSecret

string | null

Response

Saved

provider

string

required

merchantId

string

required

enabled

boolean

required

displayOrder

integer

required

credentialsSet

boolean

required

Whether a credential is stored. The credential itself is never returned.

webhookSecretSet

boolean

required

adapterRecurring

boolean

required

What the compiled-in adapter declares. The operator switch can only narrow this.

recurringEnabled

boolean

required

recurringTestStatus

enum<string>

required

Available options:

untested,

passed,

failed

connectionStatus

enum<string>

required

Available options:

unknown,

healthy,

failing

webhookStatus

enum<string>

required

Available options:

unknown,

healthy,

failing

updatedAt

string<date-time>

required

recurringTestedAt

string<date-time>

connectionCheckedAt

string<date-time>

connectionErrorCode

string

webhookLastEventAt

string<date-time>

webhookLastErrorCode

string

Start

Architecture

For customers

Commerce

Integrations

API reference

Operator panel

AI and MCP

Running Omniflow

Contributing

Put v1panelsettingsproviders

Headers

Path Parameters

Body

Response