/api/v1/beneficiaries/deleteBeneficiary

Archive a beneficiary

curl --request POST \
  --url https://api.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <x-signature>' \
  --header 'x-timestamp: <x-timestamp>' \
  --data '
{
  "beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary"

payload = { "beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "x-timestamp": "<x-timestamp>",
    "x-signature": "<x-signature>",
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-timestamp': '<x-timestamp>',
    'x-signature': '<x-signature>',
    'x-api-key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({beneficiary_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary', 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.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary",
  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([
    'beneficiary_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-signature: <x-signature>",
    "x-timestamp: <x-timestamp>"
  ],
]);

$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.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary"

	payload := strings.NewReader("{\n  \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-timestamp", "<x-timestamp>")
	req.Header.Add("x-signature", "<x-signature>")
	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary")
  .header("x-timestamp", "<x-timestamp>")
  .header("x-signature", "<x-signature>")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-timestamp"] = '<x-timestamp>'
request["x-signature"] = '<x-signature>'
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "active"
  }
}

{
  "ok": false,
  "request_id": "8c1f4b2a-9d3e-4a71-b6c8-5e2f0a7d1934",
  "error": {
    "code": "insufficient_funds",
    "message": "Insufficient available balance. Available: 5.00 USDT"
  }
}

{
  "ok": false,
  "request_id": "8c1f4b2a-9d3e-4a71-b6c8-5e2f0a7d1934",
  "error": {
    "code": "insufficient_funds",
    "message": "Insufficient available balance. Available: 5.00 USDT"
  }
}

{
  "ok": false,
  "request_id": "8c1f4b2a-9d3e-4a71-b6c8-5e2f0a7d1934",
  "error": {
    "code": "insufficient_funds",
    "message": "Insufficient available balance. Available: 5.00 USDT"
  }
}

{
  "ok": false,
  "request_id": "8c1f4b2a-9d3e-4a71-b6c8-5e2f0a7d1934",
  "error": {
    "code": "insufficient_funds",
    "message": "Insufficient available balance. Available: 5.00 USDT"
  }
}

{
  "ok": false,
  "request_id": "8c1f4b2a-9d3e-4a71-b6c8-5e2f0a7d1934",
  "error": {
    "code": "insufficient_funds",
    "message": "Insufficient available balance. Available: 5.00 USDT"
  }
}

POST

api

beneficiaries

deleteBeneficiary

Archive a beneficiary

curl --request POST \
  --url https://api.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <x-signature>' \
  --header 'x-timestamp: <x-timestamp>' \
  --data '
{
  "beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary"

payload = { "beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "x-timestamp": "<x-timestamp>",
    "x-signature": "<x-signature>",
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-timestamp': '<x-timestamp>',
    'x-signature': '<x-signature>',
    'x-api-key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({beneficiary_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary', 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.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary",
  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([
    'beneficiary_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-signature: <x-signature>",
    "x-timestamp: <x-timestamp>"
  ],
]);

$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.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary"

	payload := strings.NewReader("{\n  \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-timestamp", "<x-timestamp>")
	req.Header.Add("x-signature", "<x-signature>")
	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary")
  .header("x-timestamp", "<x-timestamp>")
  .header("x-signature", "<x-signature>")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-timestamp"] = '<x-timestamp>'
request["x-signature"] = '<x-signature>'
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "active"
  }
}

{
  "ok": false,
  "request_id": "8c1f4b2a-9d3e-4a71-b6c8-5e2f0a7d1934",
  "error": {
    "code": "insufficient_funds",
    "message": "Insufficient available balance. Available: 5.00 USDT"
  }
}

{
  "ok": false,
  "request_id": "8c1f4b2a-9d3e-4a71-b6c8-5e2f0a7d1934",
  "error": {
    "code": "insufficient_funds",
    "message": "Insufficient available balance. Available: 5.00 USDT"
  }
}

{
  "ok": false,
  "request_id": "8c1f4b2a-9d3e-4a71-b6c8-5e2f0a7d1934",
  "error": {
    "code": "insufficient_funds",
    "message": "Insufficient available balance. Available: 5.00 USDT"
  }
}

{
  "ok": false,
  "request_id": "8c1f4b2a-9d3e-4a71-b6c8-5e2f0a7d1934",
  "error": {
    "code": "insufficient_funds",
    "message": "Insufficient available balance. Available: 5.00 USDT"
  }
}

{
  "ok": false,
  "request_id": "8c1f4b2a-9d3e-4a71-b6c8-5e2f0a7d1934",
  "error": {
    "code": "insufficient_funds",
    "message": "Insufficient available balance. Available: 5.00 USDT"
  }
}

The field above is what you encrypt, not what goes on the wire. The body is always { "data": "<aes-256-gcm ciphertext>" } — see Authentication.

POST, not DELETE. The consumer API carries an AES-encrypted request body, which a DELETE cannot carry reliably — so the action is in the path and the id is in the encrypted payload.

This archives, it does not erase

The beneficiary’s status becomes archived. It can no longer be selected for a new payout, and payouts that already used it keep their own snapshot of the recipient — which is what preserves the audit trail on money that has already moved. There is no un-archive endpoint. Save the recipient again if you need it back.

Example request

The snippets assume you have already encrypted the body and signed the request — see the Quickstart for the full helper in Node and Python.

const archived = await call(
  '/api/v1/beneficiaries/deleteBeneficiary',
  { beneficiary_id: 'b7c1e2a4-9d3e-4a71-b6c8-5e2f0a7d1934' },
  jwt,
)

status, body = call('/api/v1/beneficiaries/deleteBeneficiary', {
    'beneficiary_id': 'b7c1e2a4-9d3e-4a71-b6c8-5e2f0a7d1934',
}, jwt)

curl -X POST "https://api.pontisglobe.com/api/v1/beneficiaries/deleteBeneficiary" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-timestamp: 1748023400" \
  -H "x-signature: 2f8a9b…" \
  -H "authorization: Bearer YOUR_JWT" \
  -d '{"data":"<encrypted blob>"}'

See Beneficiaries for how saving and reusing recipients fits together, and Errors for the envelope shape shared by every endpoint.

Authorizations

x-api-key

string

header

required

Identifies your account. Issued from Developer Tools in the dashboard.

Authorization

string

header

required

Short-lived token from /api/v1/user/login, bound to your account and mode. Expires in 900 seconds.

Headers

x-timestamp

integer<int64>

required

Unix epoch in seconds — not milliseconds. Must be within ±5 minutes of our clock, which is what makes a captured request unusable later. Keep your client's clock NTP-synced.

Example:

1748023400

x-signature

string

required

HMAC-SHA256 over the signing string, hex encoded. The timestamp is part of what is signed, so a replayed body cannot be re-dated. See https://docs.pontisglobe.com/authentication for how it is built.

Example:

"2f8a9b4c1d7e0a3f6b8c2d5e9f1a4b7c0d3e6f9a2b5c8d1e4f7a0b3c6d9e2f5a"

Body

application/json

beneficiary_id

string<uuid>

required

Response

Archived.

enum<boolean>

Available options:

true

data

object

Show child attributes

​This archives, it does not erase

​Example request

Authorizations

Headers

Body

Response

This archives, it does not erase

Example request