List account close requests

POST

/order/v1/banking/accounts/close-requests/paged/list

• Sandbox

Get a paginated list of your account closure requests, filtered by the criteria you provide.

Authorizations

• Bearer

Request Body ^required

object

skip

required

Skip

number

take

required

Take

number

requireTotalCount

Require total count

boolean

group

Group

string

queryFilter

required

QueryFilter

string

sortFilter

required

SortFilter

string

Responses

200

The resource was returned successfully

object

data

required

The data to retrieve the list item.

Array<object>

object

totalCount

required

The total value of the results.

number

data

Array

One of:

object

object

key

required

The key of the group results.

string

count

required

The total value of the group results.

number

object

object

closeAccountRequestId

required

Identifier of the close account request.

string

status

required

Status of the close account request.

string

Allowed values: PENDING CONFIRMED CANCELLED

accountId

required

Identifier of the account.

string

closeRequestReason

Reason informed by the caller when creating the request.

string

closureReason

Closure reason set on analysis.

string

Allowed values: CUSTOMER_REQUEST INACTIVITY FRAUD_SUSPECTED RISK_POLICIES REGULATORY_REQUEST DUPLICATE_ACCOUNT

analysisObservation

Observation added on analysis.

string

analysedBy

Who analysed the request.

object

name

required

Name of who analysed the request.

string

email

required

Email of who analysed the request.

string

createdAt

required

Creation date.

string

updatedAt

Last update date.

string

400

object

error

string

Example

INVALID_REQUEST

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Unauthorized Request

object

error

string

Example

UNAUTHORIZED

message

string

Example

Unauthorized Request

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

403

object

error

string

Example

FORBIDDEN_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

500

object

error

string

Example

INTERNAL_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]