Delete Netevia's account number - Payee.

Delete Payee

The Delete Payee endpoint removes a specific payee from a customer's payee list using the payee's financial account ID. Once deleted, the payee is no longer active in the system and cannot receive future transfers or payments. This endpoint provides a secure mechanism to maintain an accurate and current payee list.

Endpoint

POST /api/fundsMovement/deletePayee

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when a customer wants to remove a payee they no longer need, such as when a business relationship ends or a recipient account is closed. This helps keep payee lists clean and prevents accidental transfers to outdated or unwanted recipients. Optionally, the force flag can be used to remove a payee even if there are conditions that would normally block deletion.

Request Body

{
  "financialAccountId": "fa_XXXXXXXXXXXXXXXXXX",
  "force": false
}

Response

200 OK

A successful response confirms the payee was removed from the system. The response body is a confirmation message with no structured payload.

"Payee successfully deleted."

Error Codes

Common Mistakes

• Omitting financialAccountId entirely or passing an empty string — this field is required and must have at least one character.
• Attempting to delete a payee that has pending or in-flight transactions without setting force: true; the deletion may be blocked by default safety checks.
• Reusing an old or expired Bearer token — tokens expire after 10 minutes and must be refreshed before making this call.

Related Endpoints

• POST /api/fundsMovement/addPayee — Add a Netevia financial account as a payee for future transfers
• GET /api/fundsMovement/getPayees — Retrieve the list of all payees associated with an account
• POST /api/fundsMovement/transfer — Initiate a transfer to an existing payee

Example

curl -X POST https://api.banking.netevia.dev/api/fundsMovement/deletePayee \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "financialAccountId": "fa_XXXXXXXXXXXXXXXXXX",
    "force": false
  }'