Delete external banking account number - Payee

Delete External Payee

The Delete External Payee endpoint allows you to remove an external payee (bank account) from a customer's list of payees. Once deleted, the payee is deactivated and no further transactions can be processed to or from that account. This operation requires a valid financial account ID and proper authentication to ensure only authorized users can remove payees.

Endpoint

DELETE /api/fundsMovement/externalPayee

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 needs to remove an external bank account they previously added as a payee. This is appropriate when a payee account is no longer valid, the customer wants to revoke access to a particular external account, or as part of an account cleanup workflow. Once removed, the payee is permanently deactivated and cannot be used for ACH transfers until re-added.

Request Body

{
  "financialAccountId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "force": false
}

Response

200 OK

A successful response confirms that the external payee has been removed from the system.

{
  "message": "External payee successfully deleted.",
  "financialAccountId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Error Codes

Common Mistakes

• Omitting financialAccountId in the request body — this field is required and must be a non-empty string.
• Attempting to delete a payee that has pending or in-flight transactions without setting force: true may result in an error; use the force flag with caution.
• Reusing a deleted payee ID in subsequent transfer requests will result in a 404 error since deactivated payees are no longer available.
• Confusing the internal Netevia financial account ID with an external bank account number — always use the system-assigned financialAccountId, not the raw account number.

Related Endpoints

• POST /api/fundsMovement/externalPayee — Add a new external payee (bank account) to a customer's payee list
• GET /api/fundsMovement/externalPayee — Retrieve the list of external payees associated with a customer
• POST /api/fundsMovement/ach — Initiate an ACH transfer to a pre-added external payee

Example

curl -X DELETE https://api.banking.netevia.dev/api/fundsMovement/externalPayee \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "financialAccountId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "force": false
  }'