Delete External Account

Delete an external account in ACTIVE or INACTIVE status. No schedules should exist for the external account to be deleted.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type for the customer. Use 'id' for the Passport-assigned ID or 'externalId' for the program manager-assigned ID.

Allowed:
string
required

The customer identifier value, corresponding to the selected parentIdType.

string
enum
required

Identifier type for the external account. Use 'id' for the Passport-assigned ID or 'externalId' for the program manager-assigned ID.

Allowed:
string
required

The external account identifier value, corresponding to the selected idType.

Headers
string
enum
required

Controls response timing. NEVER returns an immediate response; ALWAYS defers processing.

Allowed:
Responses

202

The request has been accepted for processing. Expected when PromiseMode is ALWAYS.

400

The request could not be processed due to invalid or missing parameters.

401

The request lacks valid authentication credentials. Verify the API key and authorization header.

403

The authenticated user does not have permission to perform this operation.

500

An unexpected error occurred on the Passport server while processing the request.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json