/funding-recipients/{recipientId}deleteFundingRecipientUse this method to delete a funding recipient, including its funding accounts and owners.
To delete a funding recipient, you need its recipientId. Our gateway returned the recipientId in the response of the Create Funding Recipient method.
Note: If you don't have the recipientId, use our List Funding Recipients method to search for the funding recipient.
| Name | In | Type | Description |
|---|---|---|---|
recipientIdRequired | path | integer | Unique identifier that we assigned to the funding recipient. |
Successful request. We deleted the funding recipient.
No response body — a 204 means the action took effect.
Invalid request
{
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid date",
"message": "Expected time, got '' for start_time",
"parameter": "start_time"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}Identity could not be verified
{
"detail": "Your identity could not be verified",
"status": 401,
"title": "Not Authorized",
"type": "https://docs.payroc.com/api/errors#not-authorized"
}Do not have permissions to perform this action
{
"detail": "You do not have the required permissions to perform this action",
"instance": "https://api.payroc.com/v1/exampleResource/3",
"resource": "exampleResource",
"status": 403,
"title": "Forbidden",
"type": "https://docs.payroc.com/api/errors#forbidden"
}Resource not found
{
"detail": "Resource not found",
"resource": "(The Type of the Resource)",
"status": 404,
"title": "Not found",
"type": "https://docs.payroc.com/api/errors#not-found"
}An error has occured
{
"detail": "We are unable to process your request at this time",
"errors": [
{
"message": "Service offline"
}
],
"status": 500,
"title": "Api error",
"type": "https://docs.payroc.com/api/errors#api-error"
}