Merchant Connector - Delete

Delete a Merchant Connector for a merchant account.

Endpoint DELETE /account/{account_id}/connectors/{merchant_connector_id}

Request example (cURL)

curl
curl --request DELETE \
  --url https://sandbox.hyperswitch.io/account/{account_id}/connectors/{merchant_connector_id} \
  --header 'api-key: <api-key>'

Response example (200)

200.json
{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "merchant_connector_id": "mca_5apGeP94tMts6rg3U3kR",
  "deleted": false
}

Authorizations

  • Header: api-key (string, required) Admin API keys allow privileged actions such as creating a merchant account and Merchant Connector account.

Path parameters

  • account_id (string, required) The unique identifier for the merchant account.

  • merchant_connector_id (string, required) The unique identifier for the Merchant Connector.

Response (200 — application/json)

  • merchant_id (string, required) The identifier for the Merchant Account. Maximum length: 255 Example: "y3oqhf46pyzuxjbcn2giaqnb44"

  • merchant_connector_id (string, required) Unique ID of the connector. Example: "mca_5apGeP94tMts6rg3U3kR"

  • deleted (boolean, required) If the connector is deleted or not. Example: false

Related

  • Merchant Connector — Update: https://api-reference.hyperswitch.io/v1/merchant-connector-account/merchant-connector--update

  • Merchant Connector — List: https://api-reference.hyperswitch.io/v1/merchant-connector-account/merchant-connector--list

Edit or raise an issue

  • Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/merchant-connector-account/merchant-connector--delete.mdx

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

PreviousPayment Method Session - Confirm a payment method sessionNextAPI Key - Create