Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Bank account restrictions

List bank account restrictions

Lists restrictions on a bank account.

Returns all restrictions (both active and lifted) by default. Use filter[restriction-status][eq]=active to return only active restrictions.

See get restriction for details on field visibility and redaction.

get/v0/bank/accounts/{bank-account-id}/restrictions

Path parameters

bank-account-idstring required

Query parameters

filter[restriction-status][eq]'lifted' | 'active'

Return only restrictions with the given restriction-status.

sort'-created-at' | 'created-at'
page[size]integer
page[after]string byte

A base64 encoded opaque string returned in paginated responses.

page[before]string byte

A base64 encoded opaque string returned in paginated responses.

Response

OK

Example response

{
  "bank-account-restrictions": [
    {
      "restriction-applied-by": {
        "user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
        "user-username": "user@example.com"
      }
    }
  ]
}