Delete a Settlement Account
DELETE /settlements/{uuId}
Description
This endpoint deletes a specific settlement account based on the provided UUID.
Required Headers
| Type | Description | |
|---|---|---|
| apiKey | string | (Required). Wallet API key for authentication. Include in the request header. |
| Authorization | string | (Required). Authentication token. Include in the request header using the "Bearer" scheme. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NGQ2Nm... |
Path Parameters
| Name | Type | Description |
|---|---|---|
| uuId | string | Settlement account UUID (Required) |
Response Code: 200 - OK
Description
Settlement deleted successfully.
Response Field
| Field | Type | Description |
|---|---|---|
| status | boolean | Indicates the overall success of the operation. |
| statusCode | integer | Represents the specific status code for the response. |
| message | string | Provides additional information about the response. |
| data | object | Contains the main data payload of the response. |
| errors | array | An array containing error details if issues occurred. |
| - message | string | Describes the error. |
| - descriptiveMessage | string | Provides a more detailed and descriptive message about the error. |
Example
<response>
<status>true</status>
<statusCode>0</statusCode>
<message>string</message>
<data></data>
<errors>
<error>
<message>string</message>
<descriptiveMessage>string</descriptiveMessage>
</error>
</errors>
</response>
Method: DELETE
>http://20.87.230.105/platform/wallets/settlements/{uuId}
Headers
| Content-Type | Value |
|---|---|
| apiKey | {{apiKey}} |
🔑 Authentication bearer
| Param | value | Type |
|---|---|---|
| token | {{accessCode}} | string |
LANGUAGE
CURL REQUEST
curl --request DELETE \
--url /settlements/{uuId} \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!