curl --request POST \
--url https://api.paywint.com/api/platform/check/update-config/{user_id} \
--header 'Content-Type: application/json' \
--header 'X-Platform-ID: <x-platform-id>' \
--header 'X-Signature: <x-signature>' \
--data '
{
"logo_url": "https://cdn.example.com/branding/acme-logo.png",
"signature_url": "https://cdn.example.com/signatures/jane-doe-sign.png",
"set_default_logo": false
}
'import requests
url = "https://api.paywint.com/api/platform/check/update-config/{user_id}"
payload = {
"logo_url": "https://cdn.example.com/branding/acme-logo.png",
"signature_url": "https://cdn.example.com/signatures/jane-doe-sign.png",
"set_default_logo": False
}
headers = {
"X-Platform-ID": "<x-platform-id>",
"X-Signature": "<x-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Platform-ID': '<x-platform-id>',
'X-Signature': '<x-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
logo_url: 'https://cdn.example.com/branding/acme-logo.png',
signature_url: 'https://cdn.example.com/signatures/jane-doe-sign.png',
set_default_logo: false
})
};
fetch('https://api.paywint.com/api/platform/check/update-config/{user_id}', 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.paywint.com/api/platform/check/update-config/{user_id}",
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([
'logo_url' => 'https://cdn.example.com/branding/acme-logo.png',
'signature_url' => 'https://cdn.example.com/signatures/jane-doe-sign.png',
'set_default_logo' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Platform-ID: <x-platform-id>",
"X-Signature: <x-signature>"
],
]);
$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.paywint.com/api/platform/check/update-config/{user_id}"
payload := strings.NewReader("{\n \"logo_url\": \"https://cdn.example.com/branding/acme-logo.png\",\n \"signature_url\": \"https://cdn.example.com/signatures/jane-doe-sign.png\",\n \"set_default_logo\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Platform-ID", "<x-platform-id>")
req.Header.Add("X-Signature", "<x-signature>")
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.paywint.com/api/platform/check/update-config/{user_id}")
.header("X-Platform-ID", "<x-platform-id>")
.header("X-Signature", "<x-signature>")
.header("Content-Type", "application/json")
.body("{\n \"logo_url\": \"https://cdn.example.com/branding/acme-logo.png\",\n \"signature_url\": \"https://cdn.example.com/signatures/jane-doe-sign.png\",\n \"set_default_logo\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywint.com/api/platform/check/update-config/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"logo_url\": \"https://cdn.example.com/branding/acme-logo.png\",\n \"signature_url\": \"https://cdn.example.com/signatures/jane-doe-sign.png\",\n \"set_default_logo\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed.",
"data": {
"logo": "https://assets.internal/check-logos/USERID/logo.png",
"signature": "https://assets.internal/check-signatures/USERID/sign.png"
},
"queryGeneratedTime": 1718006400
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Update Check Config
Update the check settings for a specific user, including branding and preferences used when mailing checks.
This endpoint:
- Requires platform API key authentication
- Ensures the
user_idbelongs to the requesting platform - Updates settings such as check logo, signature, and related preferences
- Supports resetting the logo to the system default
- Returns the updated check settings in a standardized response
curl --request POST \
--url https://api.paywint.com/api/platform/check/update-config/{user_id} \
--header 'Content-Type: application/json' \
--header 'X-Platform-ID: <x-platform-id>' \
--header 'X-Signature: <x-signature>' \
--data '
{
"logo_url": "https://cdn.example.com/branding/acme-logo.png",
"signature_url": "https://cdn.example.com/signatures/jane-doe-sign.png",
"set_default_logo": false
}
'import requests
url = "https://api.paywint.com/api/platform/check/update-config/{user_id}"
payload = {
"logo_url": "https://cdn.example.com/branding/acme-logo.png",
"signature_url": "https://cdn.example.com/signatures/jane-doe-sign.png",
"set_default_logo": False
}
headers = {
"X-Platform-ID": "<x-platform-id>",
"X-Signature": "<x-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Platform-ID': '<x-platform-id>',
'X-Signature': '<x-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
logo_url: 'https://cdn.example.com/branding/acme-logo.png',
signature_url: 'https://cdn.example.com/signatures/jane-doe-sign.png',
set_default_logo: false
})
};
fetch('https://api.paywint.com/api/platform/check/update-config/{user_id}', 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.paywint.com/api/platform/check/update-config/{user_id}",
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([
'logo_url' => 'https://cdn.example.com/branding/acme-logo.png',
'signature_url' => 'https://cdn.example.com/signatures/jane-doe-sign.png',
'set_default_logo' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Platform-ID: <x-platform-id>",
"X-Signature: <x-signature>"
],
]);
$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.paywint.com/api/platform/check/update-config/{user_id}"
payload := strings.NewReader("{\n \"logo_url\": \"https://cdn.example.com/branding/acme-logo.png\",\n \"signature_url\": \"https://cdn.example.com/signatures/jane-doe-sign.png\",\n \"set_default_logo\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Platform-ID", "<x-platform-id>")
req.Header.Add("X-Signature", "<x-signature>")
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.paywint.com/api/platform/check/update-config/{user_id}")
.header("X-Platform-ID", "<x-platform-id>")
.header("X-Signature", "<x-signature>")
.header("Content-Type", "application/json")
.body("{\n \"logo_url\": \"https://cdn.example.com/branding/acme-logo.png\",\n \"signature_url\": \"https://cdn.example.com/signatures/jane-doe-sign.png\",\n \"set_default_logo\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywint.com/api/platform/check/update-config/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"logo_url\": \"https://cdn.example.com/branding/acme-logo.png\",\n \"signature_url\": \"https://cdn.example.com/signatures/jane-doe-sign.png\",\n \"set_default_logo\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed.",
"data": {
"logo": "https://assets.internal/check-logos/USERID/logo.png",
"signature": "https://assets.internal/check-signatures/USERID/sign.png"
},
"queryGeneratedTime": 1718006400
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.
HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.
Path Parameters
Unique identifier (UUID) of the user whose check config is being updated.
Body
Public HTTPS URL of the logo to use on checks. Ignored if set_default_logo is true.
"https://cdn.example.com/branding/acme-logo.png"
Public HTTPS URL of the signature image to use on checks.
"https://cdn.example.com/signatures/jane-doe-sign.png"
When true, clears the custom logo and uses the paywint logo.
false
Response
Successful Response
Indicates whether the request was processed successfully.
true
A short, human-readable message describing the result of the request.
"Operation completed."
The main response payload, if applicable
Show child attributes
Show child attributes
The Unix timestamp (in seconds) indicating when the response was generated.
1718006400

