Archive Bank Account
Header Parameters
X-Request-Idstring
Optional correlation ID associated with the request.
Authorizationstring
Query Parameters
consumer_idstring Required
The unique identifier (UUID) for the consumer whose bank account is being archived.
bank_account_usestring
Optional filter for the intended use of the bank account.
Path Parameters
bank_account_idstring Required
The unique identifier (UUID) for the bank account to be archived.
Response
200
Object
Bank account successfully archived
Response Attributes
idstring Required
The system unique identifier for the archived bank account
account_usestring Required
The account use of the archived bank account (set to ARCHIVED)
400
Object
Bad Request - Invalid input provided
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
401
Object
Unauthorized
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
403
Object
Forbidden
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
404
Object
Bank account not found
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
409
Object
Conflict - Business rule violation
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
500
Object
Internal Server Error
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
default
Object
Unexpected error
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
Was this section helpful?
Response
Was this section helpful?