Customers - Delete

DELETE /v2/customers/{id}

cURL

curl
curl --request DELETE \
  --url https://sandbox.hyperswitch.io/v2/customers/{id} \
  --header 'api-key: <api-key>'

Response (200 application/json)

response.json
{
  "id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
  "merchant_reference_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "customer_deleted": false,
  "address_deleted": false,
  "payment_methods_deleted": false
}

Authorizations

  • api-key (string, header, required) Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Path Parameters

  • id (string, required) — The unique identifier for the Customer

Response Schema (200)

  • id (string, required) Unique identifier for the customer Required string length: 32 - 64 Example: "12345_cus_01926c58bc6e77c09e809964e72af8c8"

  • merchant_reference_id (string, required) The identifier for the customer object Maximum string length: 255 Example: "cus_y3oqhf46pyzuxjbcn2giaqnb44"

  • customer_deleted (boolean, required) Whether customer was deleted or not Example: false

  • address_deleted (boolean, required) Whether address was deleted or not Example: false

  • payment_methods_deleted (boolean, required) Whether payment methods deleted or not Example: false

Related links

  • Documentation: https://api-reference.hyperswitch.io/introduction

  • Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

  • Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

  • Source edit: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/customers/customers--delete.mdx

  • Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/customers/customers--delete

  • Previous/Next:

    • Customers - Update: https://api-reference.hyperswitch.io/v2/customers/customers--update

    • Customers - List: https://api-reference.hyperswitch.io/v2/customers/customers--list