Skip to content
/Account closure requests

Account management (1.0)

Download OpenAPI description
account-management.json
account-management.yaml
Languages
Servers
Mock Server
https://docs.solarisgroup.com/_mock/api-reference/digital-banking/account-management/

Accounts

Operations

Person accounts

Operations

Business accounts

Operations

Reference accounts

Operations

Account closure requests

Operations

Initiate account closure request

Request

Creates an account closure request for the specified account. See the account closure guide for more information about this process and the associated stages.

Bodyapplication/jsonrequired
account_idstringrequired

ID of the account to be closed.

Example: "5526853938474f3e92b22a03ea57a544cacc"
closure_reasonstringrequired
Enum"ACCOUNT_REVOCATION""CUSTOMER_WISH""PARTNER_SERVICE_ACCOUNT_TERMINATED""RELATIONSHIP_TERMINATION""COMPLIANCE_IMMEDIATE_PARTNER"
Example: "CUSTOMER_WISH"
application/json
{
  "account_id": "5526853938474f3e92b22a03ea57a544cacc",
  "closure_reason": "CUSTOMER_WISH"
}

Responses

The operation was successful (idempotency).

Bodyapplication/json
idstring

ID of the account closure request.

Example: "f8d7fbbd587047a0aa449ce69d2d6c08acrq"
closure_reasonstring
Enum"ACCOUNT_REVOCATION""ACCOUNT_REVOCATION_INTERNAL""COMPLIANCE_IMMEDIATE_INTERNAL""COMPLIANCE_ORDINARY_INTERNAL""CUSTOMER_WISH""CUSTOMER_WISH_INTERNAL""DUNNING_DECOUPLED_CARD_INTERNAL""INSOLVENCY_IMMEDIATE_INTERNAL""INSOLVENCY_ORDINARY_INTERNAL""PARTNER_SERVICE_ACCOUNT_TERMINATED"
Example: "COMPLIANCE_IMMEDIATE_INTERNAL"
statusstring
Enum"INITIATED""CONFIRMED""IN_PROGRESS""COMPLETED""FAILED""REVOKED"
Example: "IN_PROGRESS"
account_idstring

ID of the account to be closed.

Example: "5526853938474f3e92b22a03ea57a544cacc"
technical_closure_datestring(date)

The date when the account was removed from the Solaris system.

Example: "2021-10-11"
legal_closure_datestring(date)

The date when the contractual relationship underlying the product/account ends.

Example: "2021-10-11"
failure_reasonobject

An object containing information about the reason why an account closure request has failed.

Example: {"code":"negative_balance","detail":"Account balance is negative, can't perform technical closure."}
payout_allowedboolean

payout_allowed is deciding whether the funds can be paid out in the automated process, but it also serves as information for the Partner on whether or not the Customer is allowed to pay out funds from the account.

Enumfalsetrue
updated_atstring(date-time)

Updated date and time

Example: "2021-12-22T15:05:33.634Z"
Response
application/json
{
  "id": "f8d7fbbd587047a0aa449ce69d2d6c08acrq",
  "closure_reason": "COMPLIANCE_IMMEDIATE_INTERNAL",
  "status": "IN_PROGRESS",
  "account_id": "5526853938474f3e92b22a03ea57a544cacc",
  "technical_closure_date": "2021-10-11",
  "legal_closure_date": "2021-10-11",
  "failure_reason": {
    "code": "negative_balance",
    "detail": "Account balance is negative, can't perform technical closure."
  },
  "payout_allowed": false,
  "updated_at": "2021-12-22T15:05:33.634Z"
}

List all account closure requests

Request

Returns an array containing all account closure requests.

Query
filter[account_id]string

Filter the response by account ID.

filter[status]string(status_enum)

Filter the response by the status of the ACR.

Enum"INITIATED""CONFIRMED""IN_PROGRESS""COMPLETED""FAILED""REVOKED"
Example: filter[status]=IN_PROGRESS
filter[legal_closure_date][min]string

Filter the response by legal closure date (min border).

filter[legal_closure_date][max]string

Filter the response by legal closure date (max border).

sortstring

Sort the returned ACRs by legal_closure_date or created_at.

page[size]integer[ 1 .. 1000 ]

Determines the size of each page of results.

Default 10
page[number]integer>= 1

The number of results pages to return.

Default 1
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

ID of the account closure request.

Example: "f8d7fbbd587047a0aa449ce69d2d6c08acrq"
closure_reasonstring
Enum"ACCOUNT_REVOCATION""ACCOUNT_REVOCATION_INTERNAL""COMPLIANCE_IMMEDIATE_INTERNAL""COMPLIANCE_ORDINARY_INTERNAL""CUSTOMER_WISH""CUSTOMER_WISH_INTERNAL""DUNNING_DECOUPLED_CARD_INTERNAL""INSOLVENCY_IMMEDIATE_INTERNAL""INSOLVENCY_ORDINARY_INTERNAL""PARTNER_SERVICE_ACCOUNT_TERMINATED"
Example: "COMPLIANCE_IMMEDIATE_INTERNAL"
statusstring
Enum"INITIATED""CONFIRMED""IN_PROGRESS""COMPLETED""FAILED""REVOKED"
Example: "IN_PROGRESS"
account_idstring

ID of the account to be closed.

Example: "5526853938474f3e92b22a03ea57a544cacc"
technical_closure_datestring(date)

The date when the account was removed from the Solaris system.

Example: "2021-10-11"
legal_closure_datestring(date)

The date when the contractual relationship underlying the product/account ends.

Example: "2021-10-11"
failure_reasonobject

An object containing information about the reason why an account closure request has failed.

Example: {"code":"negative_balance","detail":"Account balance is negative, can't perform technical closure."}
payout_allowedboolean

payout_allowed is deciding whether the funds can be paid out in the automated process, but it also serves as information for the Partner on whether or not the Customer is allowed to pay out funds from the account.

Enumfalsetrue
updated_atstring(date-time)

Updated date and time

Example: "2021-12-22T15:05:33.634Z"
]
Response
application/json
[
  {
    "id": "f8d7fbbd587047a0aa449ce69d2d6c08acrq",
    "closure_reason": "COMPLIANCE_IMMEDIATE_INTERNAL",
    "status": "IN_PROGRESS",
    "account_id": "5526853938474f3e92b22a03ea57a544cacc",
    "technical_closure_date": "2021-10-11",
    "legal_closure_date": "2021-10-11",
    "failure_reason": { … },
    "payout_allowed": false,
    "updated_at": "2021-12-22T15:05:33.634Z"
  }
]

Get a single account closure request

Request

Retrieves information about a specific account closure request, specified in the request URL.

Path
idstringrequired

ID of the account closure request to query.

No request payload

Responses

The operation was successful.

Bodyapplication/json
idstring

ID of the account closure request.

Example: "f8d7fbbd587047a0aa449ce69d2d6c08acrq"
closure_reasonstring
Enum"ACCOUNT_REVOCATION""ACCOUNT_REVOCATION_INTERNAL""COMPLIANCE_IMMEDIATE_INTERNAL""COMPLIANCE_ORDINARY_INTERNAL""CUSTOMER_WISH""CUSTOMER_WISH_INTERNAL""DUNNING_DECOUPLED_CARD_INTERNAL""INSOLVENCY_IMMEDIATE_INTERNAL""INSOLVENCY_ORDINARY_INTERNAL""PARTNER_SERVICE_ACCOUNT_TERMINATED"
Example: "COMPLIANCE_IMMEDIATE_INTERNAL"
statusstring
Enum"INITIATED""CONFIRMED""IN_PROGRESS""COMPLETED""FAILED""REVOKED"
Example: "IN_PROGRESS"
account_idstring

ID of the account to be closed.

Example: "5526853938474f3e92b22a03ea57a544cacc"
technical_closure_datestring(date)

The date when the account was removed from the Solaris system.

Example: "2021-10-11"
legal_closure_datestring(date)

The date when the contractual relationship underlying the product/account ends.

Example: "2021-10-11"
failure_reasonobject

An object containing information about the reason why an account closure request has failed.

Example: {"code":"negative_balance","detail":"Account balance is negative, can't perform technical closure."}
payout_allowedboolean

payout_allowed is deciding whether the funds can be paid out in the automated process, but it also serves as information for the Partner on whether or not the Customer is allowed to pay out funds from the account.

Enumfalsetrue
updated_atstring(date-time)

Updated date and time

Example: "2021-12-22T15:05:33.634Z"
Response
application/json
{
  "id": "f8d7fbbd587047a0aa449ce69d2d6c08acrq",
  "closure_reason": "COMPLIANCE_IMMEDIATE_INTERNAL",
  "status": "IN_PROGRESS",
  "account_id": "5526853938474f3e92b22a03ea57a544cacc",
  "technical_closure_date": "2021-10-11",
  "legal_closure_date": "2021-10-11",
  "failure_reason": {
    "code": "negative_balance",
    "detail": "Account balance is negative, can't perform technical closure."
  },
  "payout_allowed": false,
  "updated_at": "2021-12-22T15:05:33.634Z"
}

Fee collection

Operations

Reservations

Operations

Seizures

Operations

Bank statements

Operations

Statements of account

Operations

Fee summary statements

Operations

Person messages

Operations

Business messages

Operations

Trusted IBANs

Operations

Virtual IBANs

Operations

IBAN validation

Operations

Savings Accounts

Operations