cURL
curl --request POST \
--url https://api.example.com/v1/panel/settings/providers/{provider}/recurring \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--data '
{
"passed": true,
"enable": true,
"merchantId": "<string>"
}
'import requests
url = "https://api.example.com/v1/panel/settings/providers/{provider}/recurring"
payload = {
"passed": True,
"enable": True,
"merchantId": "<string>"
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({passed: true, enable: true, merchantId: '<string>'})
};
fetch('https://api.example.com/v1/panel/settings/providers/{provider}/recurring', 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}/recurring",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'passed' => true,
'enable' => true,
'merchantId' => '<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}/recurring"
payload := strings.NewReader("{\n \"passed\": true,\n \"enable\": true,\n \"merchantId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.example.com/v1/panel/settings/providers/{provider}/recurring")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("Content-Type", "application/json")
.body("{\n \"passed\": true,\n \"enable\": true,\n \"merchantId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/settings/providers/{provider}/recurring")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"passed\": true,\n \"enable\": true,\n \"merchantId\": \"<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>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}panel
Post v1panelsettingsproviders recurring
Requires settings.write. Records a capability test and, only on a pass, may enable automatic charging. Refused for an adapter that cannot bind a payment method, whatever the test reported.
POST
/
v1
/
panel
/
settings
/
providers
/
{provider}
/
recurring
cURL
curl --request POST \
--url https://api.example.com/v1/panel/settings/providers/{provider}/recurring \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--data '
{
"passed": true,
"enable": true,
"merchantId": "<string>"
}
'import requests
url = "https://api.example.com/v1/panel/settings/providers/{provider}/recurring"
payload = {
"passed": True,
"enable": True,
"merchantId": "<string>"
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({passed: true, enable: true, merchantId: '<string>'})
};
fetch('https://api.example.com/v1/panel/settings/providers/{provider}/recurring', 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}/recurring",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'passed' => true,
'enable' => true,
'merchantId' => '<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}/recurring"
payload := strings.NewReader("{\n \"passed\": true,\n \"enable\": true,\n \"merchantId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.example.com/v1/panel/settings/providers/{provider}/recurring")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("Content-Type", "application/json")
.body("{\n \"passed\": true,\n \"enable\": true,\n \"merchantId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/settings/providers/{provider}/recurring")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"passed\": true,\n \"enable\": true,\n \"merchantId\": \"<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>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}Headers
Echoes the token from the current session. Required on every unsafe method.
Path Parameters
Body
application/json
Response
Saved
Whether a credential is stored. The credential itself is never returned.
What the compiled-in adapter declares. The operator switch can only narrow this.
Available options:
untested, passed, failed Available options:
unknown, healthy, failing Available options:
unknown, healthy, failing