Update a payout adjustment
curl --request PATCH \
--url https://production-api.puppetvendors.com/payouts/adjustments/{id} \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"vendorId": "<string>",
"amount": 123,
"comments": "<string>",
"date": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://production-api.puppetvendors.com/payouts/adjustments/{id}"
payload = {
"vendorId": "<string>",
"amount": 123,
"comments": "<string>",
"date": "2023-11-07T05:31:56Z"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
vendorId: '<string>',
amount: 123,
comments: '<string>',
date: '2023-11-07T05:31:56Z'
})
};
fetch('https://production-api.puppetvendors.com/payouts/adjustments/{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://production-api.puppetvendors.com/payouts/adjustments/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'vendorId' => '<string>',
'amount' => 123,
'comments' => '<string>',
'date' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$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://production-api.puppetvendors.com/payouts/adjustments/{id}"
payload := strings.NewReader("{\n \"vendorId\": \"<string>\",\n \"amount\": 123,\n \"comments\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-access-token", "<api-key>")
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.patch("https://production-api.puppetvendors.com/payouts/adjustments/{id}")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vendorId\": \"<string>\",\n \"amount\": 123,\n \"comments\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/payouts/adjustments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vendorId\": \"<string>\",\n \"amount\": 123,\n \"comments\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "6aa7bfa25133067f0da9c0f1",
"shopId": "<string>",
"vendorId": "<string>",
"vendorName": "<string>",
"amount": -25,
"type": "ADDITION",
"status": "UNPAID",
"batchId": "NA",
"customId": "G6TTITU3S1",
"comments": "<string>",
"customItemDate": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}Payout Adjustments
Update a payout adjustment
Update a payout adjustment. amount and type must be changed
together, because the stored sign is derived from both; the request
schema enforces that pairing. Refused once the adjustment has been
paid or deleted.
PATCH
/
payouts
/
adjustments
/
{id}
Update a payout adjustment
curl --request PATCH \
--url https://production-api.puppetvendors.com/payouts/adjustments/{id} \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"vendorId": "<string>",
"amount": 123,
"comments": "<string>",
"date": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://production-api.puppetvendors.com/payouts/adjustments/{id}"
payload = {
"vendorId": "<string>",
"amount": 123,
"comments": "<string>",
"date": "2023-11-07T05:31:56Z"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
vendorId: '<string>',
amount: 123,
comments: '<string>',
date: '2023-11-07T05:31:56Z'
})
};
fetch('https://production-api.puppetvendors.com/payouts/adjustments/{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://production-api.puppetvendors.com/payouts/adjustments/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'vendorId' => '<string>',
'amount' => 123,
'comments' => '<string>',
'date' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$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://production-api.puppetvendors.com/payouts/adjustments/{id}"
payload := strings.NewReader("{\n \"vendorId\": \"<string>\",\n \"amount\": 123,\n \"comments\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-access-token", "<api-key>")
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.patch("https://production-api.puppetvendors.com/payouts/adjustments/{id}")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vendorId\": \"<string>\",\n \"amount\": 123,\n \"comments\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/payouts/adjustments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vendorId\": \"<string>\",\n \"amount\": 123,\n \"comments\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "6aa7bfa25133067f0da9c0f1",
"shopId": "<string>",
"vendorId": "<string>",
"vendorName": "<string>",
"amount": -25,
"type": "ADDITION",
"status": "UNPAID",
"batchId": "NA",
"customId": "G6TTITU3S1",
"comments": "<string>",
"customItemDate": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}Purpose
Change an unpaid payout adjustment.When to use
To correct the amount, type or comment before the adjustment is paid. Part of the Pay vendors with the API flow.Request and response
The parameters, request body, code examples (curl and other languages) and a full response example are shown below this section. They are generated from the OpenAPI spec.Errors
Every error has the shape{"success": false, "error": {"code", "message", "errorId", "details"}}. Branch on error.code.
| Status | Code | Meaning | Fix |
|---|---|---|---|
| 400 | VALIDATION_ERROR | A parameter or body field is missing or invalid. error.details names the field. | Fix the field and resend. |
| 404 | NOT_FOUND | The resource does not exist in your store. | Check the id. |
| 409 | see error.code | The adjustment is already paid or deleted. | Create a new adjustment instead. |
| 401 | UNAUTHORIZED | Token missing, invalid or expired. | Call POST /authenticate again and resend. |
| 403 | FORBIDDEN | The token belongs to a vendor key. | Use a merchant API key (mk_live_…). |
Previous step
Get a payout adjustmentNext step
List pending payoutsAuthorizations
JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.
Body
application/json
Was this page helpful?