For the complete documentation index, see llms.txt. This page is also available as Markdown.

Delete Customer

Delete a customer record.

Deletes a customer record. This is a hard delete — the customer row is permanently removed from the database (customerRepo.delete(...)), not soft-deleted.

Endpoint

DELETE /v1/customers/:prop

Authentication

Accepts either a merchant API key or a business-user JWT.

Header
Value

Authorization

<api_key> or Bearer <jwt>

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 "Authorization: your_api_key"
const response = await fetch("https://ramp-api.ivorypay.io/api/v1/customers/amina@example.com", {
  method: "DELETE",
  headers: {
    "Authorization": "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={
        "Authorization": "your_api_key",
    },
)

print(response.json())

Example response

Error cases

Scenario
Description

Customer has transactions

Cannot delete — customer has associated transaction history

Customer not found

No customer exists with the given identifier

Last updated