Retrieve user bank accounts and beneficiaries

GET

/api/v1/bank_accounts/list

curl --request GET \
  --url https://core.example.com/api/v1/bank_accounts/list \
  --header 'session-token: <session-token>'

• Replace with the Core URL for the target environment

Authorizations

• SessionToken

Parameters

Query Parameters

segregated_account_id

integer

ID of a business account accessible to the current user

filters

object

provider

string

account_number_compass

string

only_check

boolean

owners_card_accounts

boolean

card_accounts

boolean

id

integer

profile_id

integer

id_or_token

string

value

string

currency

string

status

string

verified

boolean

with_wallet

boolean

with_cards

boolean

outer_id

string

page

integer

>= 1

Responses

200

Account list

Media typeapplication/json

object

success

required

boolean

status

required

integer

object

One of:

Array

Array

object

id

integer

value

string

currency

string

token

string

status

string

Allowed values: pending pending_request approved declined closed

provider

string

Allowed values: default beneficiary iban cup redbanx coinspaid blockcypher rietumu card

swift_code

string

uk_sort_code

string

uk_account_number

string

approved

boolean

details

object

beneficiary_type

string

Allowed values: individual_stakeholder company_stakeholder

beneficiary_name

string

beneficiary_first_name

string

beneficiary_last_name

string

beneficiary_country

string

beneficiary_city

string

beneficiary_street

string

beneficiary_address

string

beneficiary_region

string

beneficiary_postalcode

string

beneficiary_bank

string

beneficiary_phone

string

beneficiary_email

string format: email

beneficiary_account_name

string

swift_code

string

corresponding_bank

string

corresponding_iban

string

corresponding_swift_code

string

corresponding_bank_country

string

corresponding_bank_address

string

account_number_compass

string

reference_code

string

key

additional properties

any

verified

boolean

paymentSystem

string

bank_address

string

bank_name

string

recipient_address

string

recipient_name

string

ref_code

string

account_holder

string

account_number

string

card_mask

string

card_id

integer

outer_id

string

bank_card_tokens

Array<string>

wallet

object

available

number format: double

boolean

boolean

Example

{
  "success": true,
  "status": 200,
  "object": [
    {
      "currency": "EUR",
      "status": "pending",
      "provider": "default",
      "details": {
        "beneficiary_type": "individual_stakeholder"
      }
    }
  ]
}

403

Authorization, validation, or business-rule error

Media typeapplication/json

object

success

required

boolean

status

required

integer

errors

required

One of:

Array<object>

Array<object>

object

code

string

kind

string

nullable

expiration

string

nullable

session

string

nullable

key

additional properties

any

object

object

key

additional properties

any

string

string

key

additional properties

any

Example

{
  "success": false,
  "status": 403
}