Cancel a batch
curl --request POST \
--url https://api.liddie.io/api/v1/mass-payouts/{id}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.liddie.io/api/v1/mass-payouts/{id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.liddie.io/api/v1/mass-payouts/{id}/cancel', 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.liddie.io/api/v1/mass-payouts/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <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"
"net/http"
"io"
)
func main() {
url := "https://api.liddie.io/api/v1/mass-payouts/{id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.liddie.io/api/v1/mass-payouts/{id}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.liddie.io/api/v1/mass-payouts/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyMass payouts
Cancel a batch
Cancel a queued Liddie mass-payout batch before it completes. Legs that are still pending are refunded to your balance; already-sent legs are unaffected.
POST
/
api
/
v1
/
mass-payouts
/
{id}
/
cancel
Cancel a batch
curl --request POST \
--url https://api.liddie.io/api/v1/mass-payouts/{id}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.liddie.io/api/v1/mass-payouts/{id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.liddie.io/api/v1/mass-payouts/{id}/cancel', 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.liddie.io/api/v1/mass-payouts/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <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"
"net/http"
"io"
)
func main() {
url := "https://api.liddie.io/api/v1/mass-payouts/{id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.liddie.io/api/v1/mass-payouts/{id}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.liddie.io/api/v1/mass-payouts/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyCancel a queued mass-payout batch. Legs that are still pending are refunded to your balance.
The endpoint takes no request body.
Only legs still pending are refunded — legs that already went out are not coming back. Check the batch with Get a batch after cancelling to see which legs were stopped in time.
cURL
curl -X POST https://api.liddie.io/api/v1/mass-payouts/<id>/cancel \
-H "Authorization: Bearer <dashboard-jwt>"
Authorization
Dashboard-only (JWT) with themass-payouts:manage team permission. API keys are not accepted — an API key gets 401 {"error":"Invalid or expired token"}.
Unlike the create call, cancelling is not MFA-gated — a valid dashboard session with the permission is enough (cancelling only returns pending funds to your own balance). Rate limit: 10/min.
Parameters
string
required
The batch id to cancel (from List payout batches).
Full request example
JavaScript
// Dashboard-session auth: send the dashboard JWT as a Bearer token.
const res = await fetch('https://api.liddie.io/api/v1/mass-payouts/<id>/cancel', {
method: 'POST',
headers: { Authorization: 'Bearer <dashboard-jwt>' },
})
const body = await res.json()
Errors
| Status | Body | Why |
|---|---|---|
| 401 | {"error":"Invalid or expired token"} | Called with an API key or a missing/expired dashboard JWT. |
See also
- Get a batch: inspect the batch and its per-recipient legs after cancelling.
- List payout batches: find the batch id to cancel.
- Queue a batch: resubmit a corrected batch.