Retrieve Accounts

Retrieves a list of accounts given the filter parameters provided

SecurityOAuth2: OAuth2Flow
Request
query Parameters
page
integer <int32>

Page of records to get (default 0 = first page)

page_size
integer <int32>

Records to return per page (default = 20)

customer_id
string

Account holder customer ID

product_type
string
  • CLIENT - Accounts at the Client level for managing client treasury operations
  • DEPOSIT - Accounts at the Customer level account for managing customer funds on platform
  • VIRTUAL - Accounts at the Customer level account for tracking externally managed customer funds

see account concepts for more details.

Enum: "CLIENT" "DEPOSIT" "VIRTUAL"
status
string
  • OPEN - Account is open and available for use in line with its product configuration
  • CLOSED - Account is permanently closed, no further actions can be performed on the account.
  • PENDING - Account is under additional review prior to moving to the OPEN or CLOSED state. No actions can be performed on the account.
  • FROZEN - Account has been temporarily locked for all actions (deposits, transfers, exchanges and withdrawals).
  • EDD - Account (and/or customer) requires enhanced due diligence to be performed. The accounts will operate as if frozen.
  • DORMANT - No activity has been seen in the last 12 months. The account is available for use.
Enum: "OPEN" "CLOSED" "FROZEN" "PENDING" "EDD" "DORMANT"
header Parameters
Authorization
string

OAuth bearer token (see authentication flows)

x-l2f-request-id
string

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

get/v1/accounts/deposits
Response samples
application/json
{
  • "data": {
    },
  • "links": {
    }
}
© 2023 Layer2 Financial Inc. All Rights Reserved.