Delete Customer

This API is used to delete a customer or partner.

1. Request Definition

  • API URL
https://base-api.swiftfederation.com/v1.1/deleteCustomer/${customerId}
  • Request Protocol
DELETE
  • Request Header

Request Header

  • Request Body

No request body for this API.

  • Request Example
DELETE /v1.1/deleteCustomer/1 HTTP/1.1
Host: base-api.swiftfederation.com

Authorization:HMAC-SHA256 V265i4K31j991E19:bc051d2e520a462e36455dc75b2bc68e9a135bbf4d2fefbf6d2fc1f28c5aa5dc
Content-Type:application/json; charset=utf-8
X-SFD-Date:20180926T131000Z
X-SFD-Nonce:69527

2. Response Definition

This section is intended to describe response header and body data definition.

2.1. Success Response

  • Success Response Body
Field Type Description
message Boolean true or false
  • Success Response Body Example
HTTP/1.1 200
{
      "message": true
 }

2.2. Error Response

  • Error Response Code

Error Code

  • Error Response Example
HTTP/1.1 400
{
"code":"CustomerId.Invalid",
"message":"CustomerId is empty or invalid."
}
HTTP/1.1 403
{
"code":"Permission.Forbidden",
"message":"Can't access according to this access key id."
}
HTTP/1.1 403
{
"code":"CustomerChild.Exist",
"message":"Can't execute because customer has child customer."
}
HTTP/1.1 403
{
"code":"Customer.NotExist",
"message":"Can't execute because customer does not exist."
}
© 2019 Conversant Solutions Pte Ltd. All rights reserved.            Updated 2019-06-06 15:24:05

results matching ""

    No results matching ""