Delete Customer

Delete a customer record.

Deletes a customer record. This is a soft delete — the record is deactivated but not permanently removed.

A customer can only be deleted if they have no associated transactions. If the customer has any transactions (on-ramp, off-ramp, buy, or sell), the delete will fail.

Endpoint

DELETE /v1/customers/:prop

Authentication

Header

Value

x-api-key

Your API key

Path parameters

Parameter

Type

Description

prop

string

Customer UUID, email address, or refCode

Example request

curl -X DELETE https://ramp-api.ivorypay.io/api/v1/customers/amina@example.com \
  -H "x-api-key: your_api_key"

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/customers/amina@example.com", {
  method: "DELETE",
  headers: {
    "x-api-key": "your_api_key",
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.delete(
    "https://ramp-api.ivorypay.io/api/v1/customers/amina@example.com",
    headers={
        "x-api-key": "your_api_key",
    },
)

print(response.json())

package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://ramp-api.ivorypay.io/api/v1/customers/amina@example.com", nil)
	req.Header.Set("x-api-key", "your_api_key")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

Example response

{
  "statusCode": 200,
  "success": true,
  "message": "Customer deleted successfully"
}

Error cases

Scenario

Description

Customer has transactions

Cannot delete — customer has associated transaction history

Customer not found

No customer exists with the given identifier

PreviousUpdate Customer NextCreate Virtual Account

Last updated 1 month ago

hashtagEndpoint

hashtagAuthentication

hashtagPath parameters

hashtagExample request

hashtagExample response

hashtagError cases

Endpoint

Authentication

Path parameters

Example request

Example response

Error cases