AUD Payout
Cancel Scheduled Payout
Cancel a scheduled payout payment that is set to run in the future. This endpoint is useful if you need to stop a planned payout that has not yet been processed, allowing you to make adjustments or halt the transaction before it occurs.
POST
/
v1
/
payouts
/
cancel_scheduled
Cancel Scheduled Payout
curl --request POST \
--url https://api.cleverhub.co/api/v1/payouts/cancel_scheduled \
--header 'Content-Type: application/json' \
--data '
{
"payout_payment_uuid": "123e4567-e89b-12d3-a456-426614174000"
}
'import requests
url = "https://api.cleverhub.co/api/v1/payouts/cancel_scheduled"
payload = { "payout_payment_uuid": "123e4567-e89b-12d3-a456-426614174000" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({payout_payment_uuid: '123e4567-e89b-12d3-a456-426614174000'})
};
fetch('https://api.cleverhub.co/api/v1/payouts/cancel_scheduled', 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.cleverhub.co/api/v1/payouts/cancel_scheduled",
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([
'payout_payment_uuid' => '123e4567-e89b-12d3-a456-426614174000'
]),
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.cleverhub.co/api/v1/payouts/cancel_scheduled"
payload := strings.NewReader("{\n \"payout_payment_uuid\": \"123e4567-e89b-12d3-a456-426614174000\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.cleverhub.co/api/v1/payouts/cancel_scheduled")
.header("Content-Type", "application/json")
.body("{\n \"payout_payment_uuid\": \"123e4567-e89b-12d3-a456-426614174000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleverhub.co/api/v1/payouts/cancel_scheduled")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"payout_payment_uuid\": \"123e4567-e89b-12d3-a456-426614174000\"\n}"
response = http.request(request)
puts response.read_body{
"status": "expired"
}Body
application/json
Unique identifier (UUID) for the scheduled payout payment to be cancelled. This ID is used to locate and cancel the specific payout transaction.
Example:
"123e4567-e89b-12d3-a456-426614174000"
Response
Successfully cancelled the scheduled payout payment.
The updated status of the payout payment after cancellation.
Example:
"expired"
⌘I
Cancel Scheduled Payout
curl --request POST \
--url https://api.cleverhub.co/api/v1/payouts/cancel_scheduled \
--header 'Content-Type: application/json' \
--data '
{
"payout_payment_uuid": "123e4567-e89b-12d3-a456-426614174000"
}
'import requests
url = "https://api.cleverhub.co/api/v1/payouts/cancel_scheduled"
payload = { "payout_payment_uuid": "123e4567-e89b-12d3-a456-426614174000" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({payout_payment_uuid: '123e4567-e89b-12d3-a456-426614174000'})
};
fetch('https://api.cleverhub.co/api/v1/payouts/cancel_scheduled', 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.cleverhub.co/api/v1/payouts/cancel_scheduled",
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([
'payout_payment_uuid' => '123e4567-e89b-12d3-a456-426614174000'
]),
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.cleverhub.co/api/v1/payouts/cancel_scheduled"
payload := strings.NewReader("{\n \"payout_payment_uuid\": \"123e4567-e89b-12d3-a456-426614174000\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.cleverhub.co/api/v1/payouts/cancel_scheduled")
.header("Content-Type", "application/json")
.body("{\n \"payout_payment_uuid\": \"123e4567-e89b-12d3-a456-426614174000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleverhub.co/api/v1/payouts/cancel_scheduled")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"payout_payment_uuid\": \"123e4567-e89b-12d3-a456-426614174000\"\n}"
response = http.request(request)
puts response.read_body{
"status": "expired"
}