cURL
curl --request POST \
--url https://sandbox.onconsul.com/v1/payouts/{id}/items/{item_id}/cancel \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.onconsul.com/v1/payouts/{id}/items/{item_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.onconsul.com/v1/payouts/{id}/items/{item_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))
}import requests
url = "https://sandbox.onconsul.com/v1/payouts/{id}/items/{item_id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"amount": "<string>",
"email": "jsmith@example.com",
"id": "<string>",
"recipient_id": "<string>",
"status": "processing"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Payouts
Cancel a Payout Item
POST
/
payouts
/
{id}
/
items
/
{item_id}
/
cancel
cURL
curl --request POST \
--url https://sandbox.onconsul.com/v1/payouts/{id}/items/{item_id}/cancel \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.onconsul.com/v1/payouts/{id}/items/{item_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.onconsul.com/v1/payouts/{id}/items/{item_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))
}import requests
url = "https://sandbox.onconsul.com/v1/payouts/{id}/items/{item_id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"amount": "<string>",
"email": "jsmith@example.com",
"id": "<string>",
"recipient_id": "<string>",
"status": "processing"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Cancel a single item within a payout. The item must be in
pending_claim; items in any other status return an
InvalidOperation error. For cancelling everything still
cancellable on a payout in one call, use Cancel a Payout.
Returns the updated PayoutItem snapshot.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

