curl --request POST \
--url https://production-api.puppetvendors.com/payouts/batches/{batchId}/mark-paid \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-access-token: <api-key>' \
--data '
{
"markAsPaidMethod": "bankTransfer",
"markAsPaidComments": "paid by wire on 2026-03-02"
}
'import requests
url = "https://production-api.puppetvendors.com/payouts/batches/{batchId}/mark-paid"
payload = {
"markAsPaidMethod": "bankTransfer",
"markAsPaidComments": "paid by wire on 2026-03-02"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-access-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
markAsPaidMethod: 'bankTransfer',
markAsPaidComments: 'paid by wire on 2026-03-02'
})
};
fetch('https://production-api.puppetvendors.com/payouts/batches/{batchId}/mark-paid', 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/batches/{batchId}/mark-paid",
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([
'markAsPaidMethod' => 'bankTransfer',
'markAsPaidComments' => 'paid by wire on 2026-03-02'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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/batches/{batchId}/mark-paid"
payload := strings.NewReader("{\n \"markAsPaidMethod\": \"bankTransfer\",\n \"markAsPaidComments\": \"paid by wire on 2026-03-02\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.post("https://production-api.puppetvendors.com/payouts/batches/{batchId}/mark-paid")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"markAsPaidMethod\": \"bankTransfer\",\n \"markAsPaidComments\": \"paid by wire on 2026-03-02\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/payouts/batches/{batchId}/mark-paid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"markAsPaidMethod\": \"bankTransfer\",\n \"markAsPaidComments\": \"paid by wire on 2026-03-02\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"requestId": "<string>",
"status": "completed",
"replay": true,
"transactionId": "<string>",
"totalPayout": 123
}
}{
"success": true,
"data": {
"requestId": "<string>",
"transactionId": "<string>",
"status": "processing",
"dryRun": false
}
}{
"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": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}Mark a payout batch as paid outside the engine (asynchronous)
Merchant scope only, requires the admin:payouts:make_payment
permission (exact match, same rule as POST /payouts/make-payment).
For batches settled outside the engine (bank transfer, cash): closes
the batch as paid with a recorded method and comment. 202 ack with
the transactionId of the batch’s run to poll
(GET /payouts/make-payment/), no totals. A replayed Idempotency-Key returns the same requestId, never
a second run.
curl --request POST \
--url https://production-api.puppetvendors.com/payouts/batches/{batchId}/mark-paid \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-access-token: <api-key>' \
--data '
{
"markAsPaidMethod": "bankTransfer",
"markAsPaidComments": "paid by wire on 2026-03-02"
}
'import requests
url = "https://production-api.puppetvendors.com/payouts/batches/{batchId}/mark-paid"
payload = {
"markAsPaidMethod": "bankTransfer",
"markAsPaidComments": "paid by wire on 2026-03-02"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-access-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
markAsPaidMethod: 'bankTransfer',
markAsPaidComments: 'paid by wire on 2026-03-02'
})
};
fetch('https://production-api.puppetvendors.com/payouts/batches/{batchId}/mark-paid', 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/batches/{batchId}/mark-paid",
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([
'markAsPaidMethod' => 'bankTransfer',
'markAsPaidComments' => 'paid by wire on 2026-03-02'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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/batches/{batchId}/mark-paid"
payload := strings.NewReader("{\n \"markAsPaidMethod\": \"bankTransfer\",\n \"markAsPaidComments\": \"paid by wire on 2026-03-02\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.post("https://production-api.puppetvendors.com/payouts/batches/{batchId}/mark-paid")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"markAsPaidMethod\": \"bankTransfer\",\n \"markAsPaidComments\": \"paid by wire on 2026-03-02\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/payouts/batches/{batchId}/mark-paid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"markAsPaidMethod\": \"bankTransfer\",\n \"markAsPaidComments\": \"paid by wire on 2026-03-02\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"requestId": "<string>",
"status": "completed",
"replay": true,
"transactionId": "<string>",
"totalPayout": 123
}
}{
"success": true,
"data": {
"requestId": "<string>",
"transactionId": "<string>",
"status": "processing",
"dryRun": false
}
}{
"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": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}Authorizations
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.
Headers
Caller-chosen dedupe key, unique per payout you intend to make. Retrying the same request with the same key returns the same requestId and never starts a second run; the engine deduplicates on it. The key is bound to its request (the batchId and the body): the same key on another batch or with a different body is refused with 422 IDEMPOTENCY_KEY_REUSED. A NEW key is a NEW payout: always retry a timed-out or failed-to-connect request with its original key, never a fresh one, or the same items can be paid twice.
8 - 128Path Parameters
The legacy batch id (a random 10-char string, not an ObjectId)
1 - 64Body
Was this page helpful?