List Synthetic Accounts

get https://sandbox.newline53.com/api/v1/synthetic_accounts

Query Params

customer_uid

string

Filter by Customer. Multiple values are allowed, e.g. customer_uid[]=uKxmLxUEiSj5h4M3&customer_uid[]=y9reyPMNEWuuYSC1.

external_uid

string

A unique, immutable id provided by the Client. Multiple values are allowed e.g. external_uid[]=uKxmLxUEiSj5h4M3&external_uid[]=y9reyPMNEWuuYSC1.

pool_uid

string

Filter by pool. Multiple values are allowed, e.g. pool_uid[]=wTSMX1GubP21ev2h&pool_uid[]=7UvkHn3Ss9AbWe2c.

limit

integer

Defaults to 100

Maximum number of items to retrieve. This filter is automatically applied with the default value if not given.

offset

integer

Defaults to 0

Index of the items to start retrieving from

synthetic_account_type_uid

string

Filter by Synthetic Account Type

synthetic_account_category

string

Filter by Synthetic Account Category

liability

boolean

Filter by liability or asset

status

string

Filter by status. Multiple values are allowed, e.g. status[]=archived&status[]=failed.

sort

string

Headers

x-trace-id

string

required

A unique identifier provided for each request. Duplicate values submitted in requests within 7 days of each other will cause the request to be rejected.

Response

Response body

object

total_count

integer

Total count of items available to retrieve

count

integer

Number of items retrieved

limit

integer

Maximum number of items to retrieve

offset

integer

Index of the first item to retrieve

data

array of objects

data

object

uid

string

Newline-generated unique id resource specific to the current endpoint

external_uid

string

length between 1 and 255

A unique identifier the Client supplies. It must be unique within the resource type. If the same value is given, no new resource will be created.

name

string

A unique name, per pool, to identify the resource

pool_uid

string

The unique id of the Synthetic Account's pool

synthetic_account_type_uid

string

A unique id referring to the Synthetic Account's type.

custodial_account_uids

array of strings

Array of unique ids of the Custodial Accounts this Synthetic Account is associated with.

custodial_account_uids

synthetic_account_category

string

The name of the Synthetic Account Category associated with the Synthetic Account Type for this account. Refer to the Synthetic Account Type for details.

general ach_external instant_payments_external wire_external

status

string

A value indicating the overall state of this Synthetic Account.

initiated active archived failed

liability

boolean

Liability or asset. Any Synthetic Account created via POST /synthetic_accounts is a liability account, except for external accounts. Some asset Synthetic Accounts are automatically created by Newline during Customer onboarding for accounting purposes.

net_usd_balance

string | null

The current settled balance of this account in US Dollars. This field will be null for synthetic_account_types in an external category (ach_external, instant_payments_external, wire_external).

net_usd_pending_balance

string | null

The sum of all pending transactions for this account in US Dollars. This field will be null for Synthetic Account Types in an external category (ach_external, instant_payments_external, wire_external).

net_usd_available_balance

string | null

The balance available to spend calculated as the settled balance less any pending withdrawals. Pending deposits are not included. This field will be null for Synthetic Account Types in an external category (ach_external, instant_payments_external, wire_external).

asset_balances

array of objects or null

A list of balances for the various asset types held in Custodial Accounts associated with this Synthetic Account.

asset_balances

object | null

asset_quantity

string

asset_type

string

current_usd_value

string

custodial_account_uid

string

custodial_account_name

string

debit

boolean

master_account

boolean

Used to identify the Master Synthetic Accounts that exist for every Program Customer. Master Synthetic Accounts are the default accounts where any unknown custodial transactions will settle and cannot be archived while a Program Customer is still active.

routing_number

string | null

The ABA routing number (if any) associated with this account. Some Synthetic Account Types require this field to be submitted along with the POST request. For example, any Synthetic Account Type from the ach_external or the wire_external category will require a routing_number. Submitting a routing_number with a Synthetic Account Type that does not require one will result in the routing number being ignored.

opened_at

date-time

The DateTime at which this account was created

closed_at

date-time | null

The DateTime at which this account was closed. This value will be present if the status is archived or failed.

ach

object | null

Contains ACH-specific information. Only populated if the Synthetic Account is in the ach_external category.

instant_payment

object | null

Contains Instant Payment-specific information. Only populated if the Synthetic Account is in the instant_payments_external category.

wire

object | null

Contains wire-specific information. Only populated if the Synthetic Account is in the wire_external category.

Headers

object

x-trace-id

string

The unique identifier provided with the request.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.newline53.com/api/v1/synthetic_accounts \
3
     --header 'accept: application/json'

Choose an example:

application/json

200A list of Synthetic Accounts is returned