Skip to content

↑↓ navigate ↵ open Ctrl↵ new tab esc close

Deletes a merchant of your company. It only works for a merchant with no linked data: no transaction, alert, event, dispute, evidence or enrollment. It is meant to undo a registration made by mistake.

A merchant with history cannot be deleted. To mark that it left, save status: "inactive" with Edit merchant; to stop receiving its alerts, request the deactivation of its enrollments.

DELETE https://api.rapidchargeback.com/api/v1/merchants/:merchant_id
Authorization: Basic base64(client_id:client_secret)

ParamTypeDescription
merchant_idstring (UUID)The merchant id

Terminal window
curl -X DELETE https://api.rapidchargeback.com/api/v1/merchants/00000000-0000-0000-0000-000000000001 \
-H "Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ="

HTTP/1.1 204 No Content

No body.

HTTP/1.1 409 Conflict
{
"error": {
"code": "MERCHANT_HAS_HISTORY",
"message": "Merchant has data (transactions, alerts, events, disputes or enrollments) and cannot be deleted. Set its status to inactive and request deactivation of its enrollments instead"
}
}

Nothing was deleted. As the message says, save status: "inactive" and request the deactivation of its enrollments (see above).

HTTPCodeWhen
404MERCHANT_NOT_FOUNDThe merchant does not exist, belongs to another company, or the id is not a UUID
409MERCHANT_HAS_HISTORYThe merchant has linked data
403KYB_NOT_APPROVED, COMPANY_NOT_ACTIVE, COMPANY_BLOCKEDCompany without an approved registration, inactive or blocked
429RATE_LIMIT_EXCEEDEDMore than 60 writes per minute
503SERVICE_UNAVAILABLETemporarily unavailable: repeat after Retry-After

  • Repeating after a 503: if the merchant had already been deleted, the new call responds 404 MERCHANT_NOT_FOUND.
  • Activity: the deletion shows up in the dashboard Activity as made by the integration.