Delete profile

POST 
/:apiKey/deleteProfile

Delete a customer profile.

In case of any errors due to invalid requests, invalid configuration or any other unexpected reason, the system will answer with a generic error response.

Request

Path Parameters

apiKey stringrequired

API Key of Connector

application/json

Body

required

Delete a customer profile

oneOf

DeleteProfileRequestGuid

profileGuid stringrequired

Customer id assigned by the payment platform.

Possible values: >= 32 characters and <= 32 characters

Example: CP-91ec-509a-3899-4f4f-a4ad-67fb

DeleteProfileRequestCustomerIdentification

customerIdentification stringrequired

Customer id assigned by you.

Possible values: non-empty and <= 36 characters

Example: my-id-620fa70b-cc34-4bbb-8d66-3670d3ea24f2

Responses

200

Delete a customer profile

application/json

Schema

Schema

success boolean
property name* any

Example (from schema)

{
  "success": true
}

default

Error response

application/json

Schema

Schema

success boolean

false if error.

errorMessage string

Error message.

While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage.

errorCode integer

Error code.

property name* any

Example (from schema)

{
  "success": true,
  "errorMessage": "string",
  "errorCode": 0
}

Loading...