Upsert Payment Method
curl --request PUT \
--url https://api.example.com/api/dashboard/payment-methods/{method} \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"display_name": "<string>",
"display_order": 100,
"config": {}
}
'import requests
url = "https://api.example.com/api/dashboard/payment-methods/{method}"
payload = {
"enabled": True,
"display_name": "<string>",
"display_order": 100,
"config": {}
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true, display_name: '<string>', display_order: 100, config: {}})
};
fetch('https://api.example.com/api/dashboard/payment-methods/{method}', 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/api/dashboard/payment-methods/{method}",
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,
'display_name' => '<string>',
'display_order' => 100,
'config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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/api/dashboard/payment-methods/{method}"
payload := strings.NewReader("{\n \"enabled\": true,\n \"display_name\": \"<string>\",\n \"display_order\": 100,\n \"config\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
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/api/dashboard/payment-methods/{method}")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"display_name\": \"<string>\",\n \"display_order\": 100,\n \"config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/dashboard/payment-methods/{method}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"display_name\": \"<string>\",\n \"display_order\": 100,\n \"config\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"method": "stripe",
"enabled": true,
"display_order": 123,
"config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"display_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Dashboard
Upsert Payment Method
Upsert payment-method config for the current merchant.
The config body field is validated against the matching per-method
schema (CodConfig / BankTransferConfig / StripeConfig) — shape
errors surface as 422.
PUT
/
api
/
dashboard
/
payment-methods
/
{method}
Upsert Payment Method
curl --request PUT \
--url https://api.example.com/api/dashboard/payment-methods/{method} \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"display_name": "<string>",
"display_order": 100,
"config": {}
}
'import requests
url = "https://api.example.com/api/dashboard/payment-methods/{method}"
payload = {
"enabled": True,
"display_name": "<string>",
"display_order": 100,
"config": {}
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true, display_name: '<string>', display_order: 100, config: {}})
};
fetch('https://api.example.com/api/dashboard/payment-methods/{method}', 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/api/dashboard/payment-methods/{method}",
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,
'display_name' => '<string>',
'display_order' => 100,
'config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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/api/dashboard/payment-methods/{method}"
payload := strings.NewReader("{\n \"enabled\": true,\n \"display_name\": \"<string>\",\n \"display_order\": 100,\n \"config\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
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/api/dashboard/payment-methods/{method}")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"display_name\": \"<string>\",\n \"display_order\": 100,\n \"config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/dashboard/payment-methods/{method}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"display_name\": \"<string>\",\n \"display_order\": 100,\n \"config\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"method": "stripe",
"enabled": true,
"display_order": 123,
"config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"display_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Body
application/json
Response
Successful Response
Single config row in dashboard responses.
Available options:
stripe, cod, bank_transfer