Skip to navigation
REST API EndpointsUsers

Cancel Ach Application

View as Markdown

Cancel an ACH application.

Available to: All authenticated users

Environments: Live

Rate Limit: No endpoint-specific limit

Cancel an ACH application that the user no longer wants to use for ACH funding. Send the application’s ID from achApplicationList as achApplicationId. A successful response is { "ok": true }.

Cancellation archives the application. For a Plaid-linked application, NinjaTrader also removes the stored Plaid connection. An archived application can’t be used for ACH funding, and the API has no operation to undo the cancellation. To fund by ACH again, link the bank account again with createPlaidLinkToken and linkPlaidItem.

After you cancel, refresh the user’s ACH applications once with achApplicationList and confirm the application now shows archived: true. Don’t call this endpoint again for an application that is already archived.

Warning: Business failures return HTTP 200 with ok: false and errorText. Check ok before treating the application as canceled.

Common Failure Scenarios

  • The ACH application ID doesn’t identify an application.
  • The ACH application is already archived.

Error Messages

MessageResponseTrigger
"ACH application not found."200 (in errorText)achApplicationId doesn’t identify an ACH application.
"ACH application is already archived."200 (in errorText)The application was canceled or archived earlier.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
achApplicationIdlongRequired

Response

SimpleResponse
okboolean
errorTextstringOptional<=8192 characters

Non-empty if the request failed