Revoke a customer (partner offboarding)
curl --request POST \
--url https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"reason": "account_closed"
}
'import requests
url = "https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke"
payload = { "reason": "account_closed" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'account_closed'})
};
fetch('https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke', 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://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke",
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([
'reason' => 'account_closed'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke"
payload := strings.NewReader("{\n \"reason\": \"account_closed\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"account_closed\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"account_closed\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Customer revoked",
"data": {
"id": "pcus_a1b2c3d4e5f6",
"status": "suspended",
"partner_customer_ref": "partner-cust-001",
"updated_at": "2026-08-31T08:00:00+00:00"
}
}{
"status": "error",
"message": "Customer cannot be revoked",
"data": {
"status": "approved"
}
}{
"status": "error",
"message": "Validation error",
"data": {
"field": "reason"
}
}Customers
Revoke a customer (partner offboarding)
Partner offboard: transition customer to suspended. Idempotent when already suspended or rejected. Optional reason is audit-only and not returned in responses. Emits customer.revoked webhook on transition.
POST
/
partner
/
customers
/
{customer_id}
/
revoke
Revoke a customer (partner offboarding)
curl --request POST \
--url https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"reason": "account_closed"
}
'import requests
url = "https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke"
payload = { "reason": "account_closed" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'account_closed'})
};
fetch('https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke', 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://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke",
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([
'reason' => 'account_closed'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke"
payload := strings.NewReader("{\n \"reason\": \"account_closed\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"account_closed\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/revoke")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"account_closed\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Customer revoked",
"data": {
"id": "pcus_a1b2c3d4e5f6",
"status": "suspended",
"partner_customer_ref": "partner-cust-001",
"updated_at": "2026-08-31T08:00:00+00:00"
}
}{
"status": "error",
"message": "Customer cannot be revoked",
"data": {
"status": "approved"
}
}{
"status": "error",
"message": "Validation error",
"data": {
"field": "reason"
}
}Authorizations
Path Parameters
Public customer id returned on create
Example:
"pcus_a1b2c3d4e5f6"
Body
application/json
Optional partner audit note (not returned in API responses).
Maximum string length:
512Example:
"account_closed"