Delete Customer - Afriex Business API

Afriex SDK

Delete a customer from your business. This action cannot be undone.

Authorizations

x-api-key

• Type: string
• Location: header
• Required: Yes

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key that does not include the permission required by the target endpoint will be rejected with a 403 Forbidden response; an unrecognised, malformed or revoked key returns 401 Unauthorized. Manage your keys and their permissions under Developer → API keys in the dashboard.

Headers

• x-api-signature
  Type: string
  Signature of the request payload, used for request authentication where payload signing is enabled for your business.
• x-api-version
  Type: string
  API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest stable.

Path Parameters

• customerId
  Type: string
  Required: Yes
  The unique identifier of the customer.

Response

• 200
  Content-Type: application/json
  Customer deleted successfully.

  {
    "data": null
  }
  

Code Examples

TypeScript

await afriex.customers.delete("customer-id");

cURL

curl --request DELETE \
  --url https://sandbox.api.afriex.com/api/v1/customer/{customerId} \
  --header 'x-api-key: <api-key>'

Python

import requests

url = "https://sandbox.api.afriex.com/api/v1/customer/{customerId}"

headers = {"x-api-key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://sandbox.api.afriex.com/api/v1/customer/{customerId}', 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.api.afriex.com/api/v1/customer/{customerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "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;
}

Go

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://sandbox.api.afriex.com/api/v1/customer/{customerId}"

req, _ := http.NewRequest("DELETE", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Unirest (Java)

HttpResponse<String> response = Unirest.delete("https://sandbox.api.afriex.com/api/v1/customer/{customerId}")
  .header("x-api-key", "<api-key>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.afriex.com/api/v1/customer/{customerId}")

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

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'

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