Delete Recipient

Overview

This endpoint enables the deletion of recipients from the platform, providing the capability to remove from specific customers their recipients as needed.

Endpoint Details

Definition	Description
Endpoint	https://api.paas.sandbox.co.passportfintech.com/v1/recipients/:recipient_id
Method	DELETE
Headers	Authorization, Accept-Language, Content-Length, Accept: application/json
Authentication	Access Token (Bearer Token)

Request Body

No request body

Example Request

JSON
    
curl --location --request DELETE 'https://api.paas.sandbox.co.passportfintech.com/v1/recipients/77d530d0-c5b4-47cc-ab5c-d073fdd6ef67' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
Copy

Response

HTTP Status Code: 204 No Content.
No response body will be returned.

Common Errors and Handling

HTTP Status Code	Meaning	Description
400 Bad Request	Invalid Data	Required fields are missing or contain incorrect values.
401 Unauthorized	Expired Token	The access token is invalid or has expired.
403 Forbidden	Access Denied	The request is not authorized to delete a Recipient.
500 Internal Server Error	Server Error	An unexpected error occurred while deleting the Recipient.

Best Practices

Always include the recipient_id identifier in the and path parameter.
Treat 204 No Content as a confirmation of success.

Last updated on