--- updatedAt: 2026-06-03T17:26:45.000Z agentTools: projectIndex: https://developers.newline53.com/llms.txt --- # List Synthetic Line Items Retrieves a list of Synthetic Line Items. These represent individual debits and credits associated with Synthetic Accounts as part of a Transaction Event. # OpenAPI definition ````json { "openapi": "3.0.2", "info": { "title": "Newline Platform API", "version": "1.0.0", "description": "\nWelcome! In this section of our docs experience, you'll be able to go through common payment scenarios that both you and your end customers may encounter as you start to offer financial products through your own technology stack. These guides will also help to highlight and expand on concepts discussed in our API references, like [Synthetic Accounts](https://developers.newline53.com/reference/synthetic-accounts), [Transfers](https://developers.newline53.com/reference/transfers), [Transactions ](https://developers.newline53.com/reference/transactions) and [Customers](https://developers.newline53.com/reference/customers).\n\nOur guides are broken out by supported use cases. If you find there isn't a specific use case that fits your business, reach out to our [Sales & Partnership team](https://newline53.com/contact-us.html) and they'll be able to help determine how we can support your business and provide any other questions or feedback.\n\nLastly, when you're ready to build, check out our [Onboarding Overview](https://developers.newline53.com/docs/overview) and [Sandbox Walkthrough](https://developers.newline53.com/docs/sandbox-walkthrough) guides.\n\n## About our API\n\nThe Newline API is organized around REST. With a few exceptions, our API has standard resource-oriented URLs, accepts form-encoded OR JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\n## FAQs\n\nWant to quickly review some common questions about Newline and our financial experiences, check out our [FAQs](https://developers.newline53.com/docs/faqs) guide.\n\n# Overview\n\n## Newline Onboarding 101\n\nOnboarding to any SaaS product can be a daunting task, and at Newline we seek to make this experience as smooth as possible. Part of that is getting you, our Client, familiar with the process by which we establish key resources like your Program, Products, Customers, Custodial Accounts, and Synthetic Accounts.\n\nThe following guide details, in short order, the Program and resources that Newline will configure for you and how each of these components affect your ability to use our API Reference.\n\n\n\nThe above visualization shows the Program and resources Newline will provide and maintain for Clients going through onboarding and implementation, but we'll enumerate the details for each resource above.\n\n> **Note**\n> In the above visualization, the lighter color items are preset and created by Newline for any Client implementation. Synthetic Accounts is a special case where general Synthetic Accounts are preset and Clients will be responsible for creating their own external Synthetic Accounts and VRNs..\n\n- **Program** - the Program dictates the origination terms to which the Client and Newline mutually agree. This could include payment limitations like amounts, frequency, and the need for pre-funding (ex. ACH). Your Program will be created and configured by Newline.\n\n- **Products** - these are distinct Product offerings supported by Newline. For instance, this can include payment rails like ACH, Wire, and Instant Payments that are configured as available synthetic_account_types. Newline creates and configures a Program's Products.\n\n - Products can be applied across multiple Customers, and Customers can be attached to multiple Products. Essentially there is a many-to-many relationship between these resources, which make them, in some cases, parallel.\n\n - A Product can support multiple payment rails.\n\n- **Customer Type** - Customers are provided a Customer Type at creation. For instance, Primary Customers are considered full account owners and have complete authority to take any actions associated with their accounts and associated resources. You can also limit certain Customer Types to have access to only certain Products. Permitted Customer Types are configured by Newline.\n\n- **Pool** - Container for one or more Synthetic Accounts, with Assets owned by one or more Customers. Pools allow for shared assets and flexibility in ownership and transfer of assets. Newline will create Pools.\n\n- **Customer** - This is the entity that owns the Account and Funds stored at Newline. This entity also is deemed the Originator when it comes to any payment creation. Clients can also be Customers in the event they meet those criteria. Customers are created by Newline or by the Client depending on the use case.\n\n- **Custodial Account** - This is the Account that exists in our Synthetic Core and represents the reciprocal Account on Fifth Third's ledger. These are the accounts you can access via Fifth Third Direct. Custodial Accounts will be created by Newline.\n\n- **Synthetic Account** - How Newline represents the assets held by your Customers. These are the accounts that Customers view and interact with on your application. Synthetic Accounts are also used to manage external accounts that your Customers will likely use within your application. Synthetic Accounts of the general category will be created by Newline or by the Client depending on your use case. Clients will create external Synthetic Accounts like wire_external, ach_external, and instant_payment_external.\n\n- **Virtual Reference Number** - Virtual Reference Numbers (or VRNs) are virtualized account numbers. They are aliases to a synthetic account and can form a many-to-one relationship with their parent synthetic account.\n\n# Postman Collection\n\nHow to set up Postman, add our Newline collection, and use it to test Newline platform APIs.\n\n## Installing Postman\n\nPostman is available on a variety of platforms. Visit [Postman](https://www.postman.com/downloads/) to see if your platform is supported. \nTo install Postman:\n\n1. Go to [Postman downloads](https://www.postman.com/downloads/).\n\n\n\n1. Download the required version.\n\n2. After your download is complete, run the downloaded file to install Postman.\n\n## Import the Newline Collection\n\nTo import our collection, click on the following [▶ Newline Collection](https://www.postman.com/newline53) button, and you will be redirected to our Newline Postman workspace, where you can download our collection.\n\nFor further information, see the [Postman documentation on importing data](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/).\n\n## Configure Your Postman Environment\n\n1. Create a Sandbox Environment.\n\n2. Set Sandbox variables.\n\n3. Save the environment.\n\n4. Ensure the new environment is selected.\n\n**Set API Keys** \nYou will need to set your HMAC Key and Program UID as environment variables. You can set the variables in the headers in the environment tab within the Postman Collection.\n\n# Terminology\n\nThe terms, which represent API resource objects in Newline, below are referenced in our API documentation and endpoint definitions. \nSome important notes while reading through this list:\n\nResource Objects often interact with one another, so please be sure to review our endpoints to see which serve as required inputs or are collected as outputs.\n\nCertain objects, like Transfers, are described differently in the payments industry depending on the Transaction Type. For instance, ach transactions are often referred to as entries rather than payments, as they can represent both credits (i.e., ODFI pushes) and debits (i.e., ODFI pulls). \nWhile Resource Objects are distinct, they, in some cases, can represent the same entity.\n\n- Ex. 1 - Clients can also be Customers if they manage and own the financial products in question.\n\n- Ex. 2 - Transfers produce Transactions, but the produced Transactions (in aggregate) represent the original money movement.\n\n| Term | Definition |\n| --- | --- |\n| Customer | The end user of your application and the owner of assets in your Program. For example, when initiating a payment, this entity would be considered the **originator**. |\n| Client | The application or product owning organization that is affording end users (i.e., Customers) the ability to access the financial products.


**Note**
Clients can also be Customers in the event they own and have management over the financial products or the funds involved. |\n| Transmitter | Transmitters are the parties who have _requested_ the Transfer in question. When the Transmitter and Customer are the same party, Newline pulls origination information from the created Customer record. When the Transmitter and Customer are not the same party, it's the Client's responsibility to provide that information when making a Transfer.

Transmitters are only required for the `wire` and `instant_payment` types (see the `wire_transmitter` and `instant_payment_transmitter` objects in the [Initiate a Transfer](https://developers.newline53.com/reference/post_transfers) reference). Client's should also take note of the `initiator_type` field, which dictates from where Transmitter information is pulled. For more context on Transmitters, refer to the [Payment Rail Regulation](https://newline-enterprise-group.readme.io/docs/transfer#payment-rail-regulation) section below. |\n| Partner | Any infrastructure partner integrated within the Newline Platform. |\n| Program | The Program is custom tailored to your offering and purpose built to enable financial products on your application. The Program defines what Synthetic and Custodial Account types, Customer Types, and Transactions Types are available for your Customers to utilize. The Program configuration is defined between the Client and Newline based on your (i.e., the Client's) use case. |\n| Product | Products represents the financial products available to your Customers. The Product object contains the account, compliance, and customer profile responses necessary for your Customers to gain access. |\n| Customer Product | The Customer Product is created when the Customer is added to a Product and respective Program. This often includes Newline automatically creating any needed financial products for the Customers' use. For instance, a Synthetic Account to represent the origination account at Fifth Third. |\n| Service Offering | The financial product offered by the Newline platform. These can be (but are not limited to) checking, savings, brokerage, or retirement accounts. |\n| Pool | Container for one or more Synthetic Accounts, with Assets owned by one or more Customers. Pools allow for shared assets and flexibility in ownership and transfer of assets. |\n| Custodial Accounts | This resource within Newline represents the assets held by your Customers, with direct alignment to accounts opened at Fifth Third. Custodial Accounts have the following relationships: one-to-one with Customers, and one-to-Many with Synthetic Accounts. |\n| Synthetic Accounts | How Newline represents the assets held by your Customers. These are the accounts that Customers view and interact with on your application. Synthetic Accounts are also used to manage external accounts (i.e., Counterparties) that your Customers will likely use within your application. |\n| Virtual Reference Number (VRN) | Virtual Reference Numbers (or VRNs) are virtualized account numbers. They are aliases to a Synthetic Account, and can form a many-to-one relationship with their parent Synthetic Account. |\n| Transfer | The movement of assets from one Synthetic Account to another Synthetic Account. Most of asset movement initiated by your application will result in a Transfer. A successful Transfer will result in at least one Transaction. |\n| Transaction | Transactions are created based on how you instruct Newline to move assets (a Transfer) or how assets are moved or spent outside of your application (For example, ACH, Wire, and Instant Payments Transfers). The Transaction contains the amount, origin, and destination of assets. Newline categorizes Transactions into types to assist in their classification and representation. |\n| Transaction Events | The steps taken to complete the Transaction. These can be used to view the progress of an in-flight Transaction or see the history of a completed Transaction. |" }, "security": [ { "ApiKeyAuth": [] } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Access token signed with shared HMAC" } } }, "x-explorer-enabled": false, "servers": [ { "url": "https://sandbox.newline53.com/api/v1" } ], "tags": [ { "name": "Auth", "description": "The Authentication section explains how to securely interact with Newline's API using access tokens and static IP addresses. Learn how to generate and refresh tokens to access protected resources. \n\n**Endpoints:**\n\n- POST [Generate an authentication token: POST /auth](https://developers.newline53.com/reference/post_auth)\n\nNewline requires access tokens and static IP addresses for authentication and authorization when requesting any resource endpoints. [POST /auth](https://developers.newline53.com/reference/post_auth) is used to obtain and refresh the required access tokens. Please work with your Relationship Team or the Newline Team in all environments to set up the IP Allowlist for your Program. \nTo obtain an access token, you must submit a refresh token. After a program is set up, Newline will share your Program UID and HMAC key offline. These values are required for the refresh token and access token requests.\n\n## Auth Flow\n\nThe authentication flow is as follows:\n\n1. Create a JWT using the following claim:\n```\n{\n \"iat\": ,\n \"sub\": \n}\n ```\n\n1. Sign the JWT to create a JWS with the shared key using HS512 / SHA-512.\n\n2. Exchange for an access token by sending a request to [POST /auth](https://developers.newline53.com/reference/post_auth), using the JWS in the `Authorization` header.\n\n3. Access resources through other endpoints using the returned token in the `Authorization` header for up to 8 hours.\n\n4. Repeat the process as needed to continue authenticating successfully.\n\n> **Note** \n> If a new access token is requested within the 8 hours of a previous token being successfully exchanged, the new token will still be generated. This does not expire the last token, and both tokens are usable simultaneously until their respective time is up. However, it is encouraged to use the new token and discard the old one if possible, as this behavior may change in the future." }, { "name": "Pools", "description": "Pools group multiple Customers for asset sharing and distributed account ownership. Each Pool is unique to a Customer or program.\n\n**Endpoints:**\n\n- GET [List Pools: GET /pools](https://developers.newline53.com/reference/get_pools)\n \n- GET [Get a single Pool: GET /pools/{uid}](https://developers.newline53.com/reference/get_pools-uid)\n\nA pool is a construct that Newline uses to associate multiple customers with each other. A Pool is always associated with at least one Customer, but all accounts are only ever associated with a single Pool. This enables asset sharing and distributed ownership of accounts across multiple Customers.\n\nNewline currently supports single Customer Pools, where **one Customer is associated with one Pool and vice versa**. All accounts, transfers, and transactions are related to the Customer's Pool, not the Customer. The Pool UID appears on several endpoint responses and may be required by the API in some instances." }, { "name": "Custodial Accounts", "description": "Fifth Third Bank holds Custodial Accounts and represents funds managed for Customers. Through these endpoints, you can manage balances and track account statuses.\n\n**Endpoints:**\n\n- GET [List Custodial Accounts: GET /custodial_accounts](https://developers.newline53.com/reference/get_custodial-accounts)\n \n- GET [Get a single Custodial Account: GET /custodial_accounts/{uid}](https://developers.newline53.com/reference/get_custodial-accounts-uid)\n\nA Custodial Account is the account held by Fifth Third Bank. Custodial Accounts in a Program can only be created for the Service Offerings that have been configured for that Program.\n\nA Customer must successfully complete onboarding and pass all KYC/AML checks before their Custodial Accounts can be opened. This endpoint can be used to retrieve the accounts (active and archived) and their balances for your Customers. All funds must be emptied from a Custodial Account before it can be archived." }, { "name": "Transfers", "description": "Transfers facilitate the movement of assets between accounts, enabling transactions such as payments and withdrawals.\n\n**Endpoints:**\n\n- GET [List Transfers: GET /transfers](https://developers.newline53.com/reference/get_transfers)\n\n- POST [Initiate a Transfer: POST /transfers](https://developers.newline53.com/reference/post_transfers)\n\n- GET [Get a single Transfer: GET /transfers/{uid}](https://developers.newline53.com/reference/get_transfers-uid)\n\n- PUT [Cancel a Transfer: PUT /transfers/{uid}/cancel](https://developers.newline53.com/reference/put_transfers-uid-cancel)\n\nA Transfer is the Action of moving assets between two Synthetic Accounts. Most asset movement initiated by your application will result in a Transfer. Asset movement is determined by the makeup of assets in both participating accounts, the Synthetic Account Type of the participating accounts, the available Custodial Accounts for all participating Customers, and the overall Program configuration. A Transfer can never be initiated between two external accounts.\n\n### Company ID Behavior\n\nThe company_id field is optional when initiating a transfer. However, it becomes required if your organization has multiple company IDs or multiple custodial accounts, to ensure accurate routing of funds. If provided, the value will be validated.\n\nIn sandbox environments:\n\n- `company_id` is optional and will be validated if supplied.\n- `company_id` and custodial accounts are always in a 1:1 relationship.\n\n> **Note** \n> Any time a Transfer is created, it creates 1+ Transactions, which are returned in the response payload for a successful Transfer. Please note or record these uids, as they will be needed to query the Transaction object and any associated key data points. For instance, Fed IMAD or CHIPS SSN is used for outgoing wires." }, { "name": "Transactions", "description": "Transactions represent asset movements, such as ACH payments, wire transfers, or card purchases. Track transaction statuses and events through these endpoints. \n**Endpoints:**\n\n- GET [List Transactions: GET /transactions](https://developers.newline53.com/reference/get_transactions)\n\n- GET [Get a single Transaction: GET /transactions/{uid}](https://developers.newline53.com/reference/get_transactions-uid)\n\n- PUT [Approve or deny a Transaction: PUT /transactions/{uid}/authorize](https://developers.newline53.com/reference/put_transactions-uid-authorize)\n\n- GET [List Transaction Events: GET /transaction_events](https://developers.newline53.com/reference/get_transaction-events)\n\n- GET [Get a single Transaction Event: GET /transaction_events/{uid}](https://developers.newline53.com/reference/get_transaction-events-uid)\n\n- GET [List Synthetic Line Items: GET /synthetic_line_items](https://developers.newline53.com/reference/get_synthetic-line-items)\n\n- GET [Get a single Synthetic Line Item: GET /synthetic_line_items/{uid}](https://developers.newline53.com/reference/get_synthetic-line-items-uid)\n\n- GET [List Custodial Line Items: GET /custodial_line_items](https://developers.newline53.com/reference/get_custodial-line-items)\n\n- GET [Get a single Custodial Line Item: GET /custodial_line_items/{uid}](https://developers.newline53.com/reference/get_custodial-line-items-uid)\n\nTransactions are created based on how you instruct Newline to move assets (a Transfer) or how assets are moved or spent outside your application (ATM withdrawals, debit card purchases, wire transfers, etc…). The Transaction contains the amount, origin, and destination of assets. Newline categorizes Transactions into types to assist in their classification and representation.\n\nTransactions fall into many categories, including debit card purchases, direct deposits, interest, and fees. This endpoint can retrieve a list of Transactions or track the status of an ongoing Transaction.\n\nTransaction Events are created as a result of a Transaction. They capture the steps required to complete the Transaction. These can be used to view the progress of an in-flight Transaction or see the history of a completed Transaction.\n\nLine Items are created for each Transaction Event. They catalog the individual credits and debits associated with the accounts involved in the Transaction." } ], "paths": { "/auth": { "parameters": [ { "in": "header", "name": "x-trace-id", "description": "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.\n", "schema": { "type": "string", "example": "123e4567-e89b-12d3-a456-426614174000" }, "required": true } ], "post": { "tags": [ "Auth" ], "summary": "Generate an authentication token", "description": "An access token can be generated by providing a refresh token. The generated token then can be used as an authentication token to access resources for up to 8 hours.\n\nThe Client will need to provide a JWS, its payload containing Program UID as `sub` (subject) and current Epoch time as `iat` (issued at timestamp), signed by an HMAC that has been shared offline previously using HS512. See the above guide for more details.\n\nWhen Newline processes the `POST /auth` request, it validates that the `iat` claim is current. A 30-second difference is allowed to account for clock skew. Nevertheless, it is important that the refresh token be submitted as quickly as possible after it is generated to avoid failure in receiving an access token. Note that the returned access token is a valid JWS following `auth-` and the whole value (`auth-header.payload.signature`) must be provided in the `Authorization` header when making requests to other endpoints.", "parameters": [ { "in": "header", "name": "Authorization", "description": "Refresh token signed with shared HMAC", "schema": { "type": "string" }, "example": "header.payload.hmacsignature", "required": true } ], "responses": { "201": { "description": "A new authentication token is generated", "headers": { "x-trace-id": { "description": "The unique identifier provided with the request.", "schema": { "type": "string", "example": "123e4567-e89b-12d3-a456-426614174000" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token that can be used in the `Authorization` header when sending requests to other endpoints for up to 8 hours.\n", "example": "auth-header.payload.signature" } } } } } } } } }, "/pools": { "parameters": [ { "$ref": "#/paths/~1auth/parameters/0" } ], "get": { "tags": [ "Pools" ], "summary": "List Pools", "description": "Retrieves a list of Pools filtered by the given parameters.\n", "parameters": [ { "name": "customer_uid", "in": "query", "schema": { "type": "string", "example": "uKxmLxUEiSj5h4M3" }, "description": "Filter by Customer. Multiple values are allowed, e.g. `customer_uid[]=uKxmLxUEiSj5h4M3&customer_uid[]=y9reyPMNEWuuYSC1`.\n" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100 }, "description": "Maximum number of items to retrieve. This filter is automatically applied with the default value if not given.\n" }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "description": "Index of the items to start retrieving from" } ], "responses": { "200": { "description": "A list of Pools is returned", "headers": { "x-trace-id": { "$ref": "#/paths/~1auth/post/responses/201/headers/x-trace-id" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "total_count": { "type": "integer", "description": "Total count of items available to retrieve", "example": 1 }, "count": { "type": "integer", "description": "Number of items retrieved", "example": 1 }, "limit": { "type": "integer", "description": "Maximum number of items to retrieve", "example": 100 }, "offset": { "type": "integer", "description": "Index of the first item to retrieve", "example": 0 } } }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/paths/~1pools~1{uid}/get/responses/200/content/application~1json/schema" } } } } ] }, "examples": { "pool_list": { "value": { "total_count": 4, "count": 2, "limit": 2, "offset": 0, "data": [ { "uid": "wTSMX1GubP21ev2h", "name": "multi-byte success", "owner_customer_uid": "uKxmLxUEiSj5h4M3", "customer_uids": [ "uKxmLxUEiSj5h4M3", "ivxTYrJtwrMC4f6w" ] }, { "uid": "7UvkHn3Ss9AbWe2c", "name": "Fundamental Frozen", "owner_customer_uid": "y9reyPMNEWuuYSC1", "customer_uids": [ "y9reyPMNEWuuYSC1", "6TbfhQFQteurvK3Y" ] } ] } } } } } } } } }, "/custodial_account_closing_balances/{uid}": { "parameters": [ { "$ref": "#/paths/~1auth/parameters/0" }, { "$ref": "#/paths/~1pools~1{uid}/parameters/1" } ], "get": { "tags": [ "Custodial Accounts" ], "summary": "Get a single Custodial Account Closing Balance", "responses": { "200": { "description": "A single Custodial Account Closing Balance is returned", "headers": { "x-trace-id": { "$ref": "#/paths/~1auth/post/responses/201/headers/x-trace-id" } }, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "uid": { "type": "string", "description": "Newline-generated unique id resource specific to the current endpoint", "readOnly": true, "example": "EhrQZJNjCd79LLYq" } } }, { "type": "object", "properties": { "custodial_account_uid": { "type": "string", "description": "A unique id referring to the Custodial Account", "example": "Jy8degj6iv2QngLo" }, "custodial_account_external_uid": { "type": "string", "description": "A unique id referring to the External Custodial Account", "example": "ptRLF7nQvy8VoqM1" }, "net_usd_closing_balance": { "type": "string", "description": "The USD amount of the Custodial Account's closing balance", "example": "12.34" }, "net_usd_closing_balance_as_of": { "type": "string", "format": "date", "example": "1978-08-17" } } } ] } } } } } } }, "/transfers": { "parameters": [ { "$ref": "#/paths/~1auth/parameters/0" } ], "get": { "tags": [ "Transfers" ], "summary": "List Transfers", "description": "Retrieves a list of Transfers filtered by the given parameters. Transfers facilitate the movement of assets between accounts, enabling transactions such as payments and withdrawals.\n", "parameters": [ { "$ref": "#/paths/~1pools/get/parameters/0" }, { "name": "external_uid", "in": "query", "schema": { "type": "string", "example": "client-generated-id" }, "description": "A unique, immutable id provided by the Client. Multiple values are allowed e.g. `external_uid[]=uKxmLxUEiSj5h4M3&external_uid[]=y9reyPMNEWuuYSC1`." }, { "name": "pool_uid", "in": "query", "schema": { "type": "string", "example": "wTSMX1GubP21ev2h" }, "description": "Filter by pool. Multiple values are allowed, e.g. `pool_uid[]=wTSMX1GubP21ev2h&pool_uid[]=7UvkHn3Ss9AbWe2c`.\n" }, { "name": "synthetic_account_uid", "in": "query", "schema": { "type": "string", "example": "4XkJnsfHsuqrxmeX" }, "description": "Filter by Synthetic Account. Multiple values are allowed, e.g. `synthetic_account_uid[]=4XkJnsfHsuqrxmeX&synthetic_account_uid[]=exMDShw6yM3NHLYV`.\n" }, { "$ref": "#/paths/~1pools/get/parameters/1" }, { "$ref": "#/paths/~1pools/get/parameters/2" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "created_at_asc", "created_at_desc" ] } } ], "responses": { "200": { "description": "A list of Transfers is returned", "headers": { "x-trace-id": { "$ref": "#/paths/~1auth/post/responses/201/headers/x-trace-id" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/paths/~1pools/get/responses/200/content/application~1json/schema/allOf/0" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/paths/~1transfers/post/responses/201/content/application~1json/schema/allOf/0" } } } } ] }, "examples": { "transactions": { "value": { "total_count": 3, "count": 3, "limit": 3, "offset": 1, "data": [ { "uid": "EhrQZJNjCd79LLYq", "external_uid": "partner-generated-id", "source_synthetic_account_uid": "4XkJnsfHsuqrxmeX", "destination_synthetic_account_uid": "exMDShw6yM3NHLYV", "initiating_customer_uid": "iDtmSA52zRhgN4iy", "destination_customer_uid": "iDtmSA52zRhgN4iy", "status": "pending", "initiator_type": "transmitter", "created_at": "2019-10-14T03:21:53.301Z", "transaction_uids": [], "usd_transfer_amount": 33.12, "wire": { "intermediary_bank_address": { "line1": "345 Def Ave", "line2": "San Francisco", "line3": "CA 94016", "country": "US" }, "intermediary_bank_name": "Fidelity Fiduciary Bank", "intermediary_bank_routing_number": "923456789", "wire_transmitter": { "name": "Top Tier Tacos", "transmitter_identifier": "123456789", "line1": "123 Abc St.", "line2": null, "line3": null, "building_number": null, "street_name": null, "city": null, "state": null, "postal_code": null, "country": "US" } } }, { "uid": "VeYqeb1iHqBR4LEi", "external_uid": "partner-created-id", "source_synthetic_account_uid": "ABv3vs5yVypxpGgF", "destination_synthetic_account_uid": "RRbw63TF4o1vg2RQ", "initiating_customer_uid": "oBugADTMCMEU4sfE", "destination_customer_uid": "22PBwMT88qCQWMSg", "status": "settled", "initiator_type": "transmitter", "created_at": "2019-10-14T03:21:53.301Z", "transaction_uids": [ "d8WUMmm4dZfMpLeh" ], "usd_transfer_amount": 32.13, "instant_payment": { "instant_payment_transmitter": { "name": "Royalty Asset Management", "transmitter_identifier": "123456789", "street_number": 123, "street1": "Abc St.", "city": "Boring", "state": "OR", "postal_code": 97009 }, "memo": "To unfreeze the prince's assets" } }, { "uid": "EhrQZJNjCd79LLYq", "external_uid": "partner-generated-id", "source_synthetic_account_uid": "4XkJnsfHsuqrxmeX", "destination_synthetic_account_uid": "exMDShw6yM3NHLYV", "initiating_customer_uid": "iDtmSA52zRhgN4iy", "destination_customer_uid": "iDtmSA52zRhgN4iy", "status": "pending", "initiator_type": "customer", "created_at": "2019-10-14T03:21:53.301Z", "transaction_uids": [], "ach": { "originator_name": "Mr. Hyyt Meiser", "company_id": "HJK867", "company_discretionary_data": "Some data", "prenote": false, "sec_code": "CCD", "payment_type": "S", "entry_description": "ACH Entry", "service_processing": "STANDARD", "effective_entry_date": "2023-12-21", "id_number": 4270465600, "addenda": "Having said that, this" } } ] } } } } } } } } }, "/transaction_events": { "parameters": [ { "$ref": "#/paths/~1auth/parameters/0" } ], "get": { "tags": [ "Transactions" ], "summary": "List Transaction Events", "description": "Retrieves a list of Transaction Events. Transaction Events represent the steps required to complete a Transaction and can be used to track its progress or review its history.", "parameters": [ { "name": "source_custodial_account_uid", "in": "query", "schema": { "type": "string", "example": "dmRtw1xkS9ghrntB", "description": "Filter by source Custodial Account. Multiple values are allowed, e.g. `source_custodial_account_uid[]=dmRtw1xkS9ghrntB&source_custodial_account_uid[]=Gw4gr1T81YrvLT6M`.\n" } }, { "name": "destination_custodial_account_uid", "in": "query", "schema": { "type": "string", "example": "W55zKgvAk3zkpGM3", "description": "Filter by destination Custodial Account. Multiple values are allowed, e.g. `destination_custodial_account_uid[]=W55zKgvAk3zkpGM3&destination_custodial_account_uid[]=66gso857LyQWC6XN`.\n" } }, { "name": "custodial_account_uid", "in": "query", "schema": { "type": "string", "example": "dmRtw1xkS9ghrntB", "description": "Filter by Custodial Account, source or destination. Multiple values are allowed, e.g. `custodial_account_uid[]=dmRtw1xkS9ghrntB&custodial_account_uid[]=W55zKgvAk3zkpGM3`.\n" } }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "odfi_ach_deposit", "odfi_ach_withdrawal", "rdfi_ach_deposit", "rdfi_ach_withdrawal" ], "example": "odfi_ach_deposit", "description": "Filter by type. Multiple values are allowed, e.g. `type[]=odfi_ach_deposit&type[]=odfi_ach_withdrawal`.\n" } }, { "name": "transaction_uid", "in": "query", "schema": { "type": "string", "example": "SMwKC1osz77DTEiu" }, "description": "Filter by Transaction. Multiple values are allowed, e.g. `transaction_uid[]=SMwKC1osz77DTEiu&transaction_uid[]=f1UDvUVNnXTKtgxu`.\n" }, { "$ref": "#/paths/~1pools/get/parameters/1" }, { "$ref": "#/paths/~1pools/get/parameters/2" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "created_at_asc", "created_at_desc", "description_asc", "description_desc", "settled_index_asc", "settled_index_desc", "us_dollar_amount_asc", "us_dollar_amount_desc" ] } } ], "responses": { "200": { "description": "A list of Transaction Events is returned", "headers": { "x-trace-id": { "$ref": "#/paths/~1auth/post/responses/201/headers/x-trace-id" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/paths/~1pools/get/responses/200/content/application~1json/schema/allOf/0" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/paths/~1transaction_events~1{uid}/get/responses/200/content/application~1json/schema" } } } } ] }, "examples": { "transactionEvents": { "value": { "total_count": 3, "count": 2, "limit": 2, "offset": 0, "data": [ { "uid": "MB2yqBrm3c4bUbou", "settled_index": 1, "transaction_uids": [ "SMwKC1osz77DTEiu", "Wfp6uBnhKDxUtCeu" ], "source_custodial_account_uid": "66gso857LyQWC6XN", "destination_custodial_account_uid": "Gw4gr1T81YrvLT6M", "custodial_line_item_uids": [ "y4r8oTATb23MdGDF", "m9bED9iicUUk8YAc" ], "status": "settled", "us_dollar_amount": "5.21", "type": "odfi_ach_deposit", "debit_card_uid": null, "net_asset": "positive", "description": "Transfer from Bank ABC 123 to Newline 999", "created_at": "2019-10-15T15:53:13.591Z", "settled_at": "2019-10-16T12:51:12.673Z" }, { "uid": "qCEEyGQw73Ajn3WZ", "settled_index": 3, "transaction_uids": [ "Ya7MQpFMeS8ViE5f" ], "source_custodial_account_uid": "pas8YFUq9kZcrAQL", "destination_custodial_account_uid": "MMdP8pNYepTgfx2z", "custodial_line_item_uids": [ "3ttFzz4sUpX6AUBZ" ], "status": "settled", "us_dollar_amount": "25.00", "type": "rdfi_ach_withdrawal", "debit_card_uid": null, "net_asset": "negative", "description": "ACH Debit from Newline account", "created_at": "2019-10-20T23:01:29.083Z", "settled_at": "2019-10-20T23:01:29.083Z" }, { "uid": "qCEEyGQw73Ajn3WZ", "settled_index": 2, "transaction_uids": [ "PpnWo5bou8J5CaDM", "QRR8akVTdA42cr6P" ], "source_custodial_account_uid": "ecdJBMYABH9PodEJ", "destination_custodial_account_uid": "k27SeCbNtKgj3ftZ", "custodial_line_item_uids": [ "JBaV8uZ9bwNThLtZ", "6ugqfz49UPQJZp1n" ], "status": "settled", "us_dollar_amount": "52.00", "type": "rdfi_ach_withdrawal", "debit_card_uid": "Ms8GGZFkdcxkRWtB", "net_asset": "negative", "description": "203 - BOB'S WIDGETS SPRINGFIELD, VA", "created_at": "2021-10-20T23:01:29.083Z", "settled_at": "2021-10-20T23:01:29.083Z" } ] } } } } } } } } }, "/synthetic_line_items": { "parameters": [ { "$ref": "#/paths/~1auth/parameters/0" } ], "get": { "tags": [ "Transactions" ], "summary": "List Synthetic Line Items", "description": "Retrieves a list of Synthetic Line Items. These represent individual debits and credits associated with Synthetic Accounts as part of a Transaction Event.", "parameters": [ { "$ref": "#/paths/~1pools/get/parameters/0" }, { "$ref": "#/paths/~1transfers/get/parameters/2" }, { "$ref": "#/paths/~1transfers/get/parameters/3" }, { "$ref": "#/paths/~1pools/get/parameters/1" }, { "$ref": "#/paths/~1pools/get/parameters/2" }, { "$ref": "#/paths/~1transaction_events/get/parameters/4" }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "begun", "failed", "in_progress", "settled" ], "description": "Filter by status. Multiple values are allowed, e.g. `status[]=begun&status[]=in_progress`.\n" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "created_at_asc", "created_at_desc", "description_asc", "description_desc", "settled_index_asc", "settled_index_desc", "us_dollar_amount_asc", "us_dollar_amount_desc" ] } } ], "responses": { "200": { "description": "A list of Synthetic Line Items is returned", "headers": { "x-trace-id": { "$ref": "#/paths/~1auth/post/responses/201/headers/x-trace-id" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/paths/~1pools/get/responses/200/content/application~1json/schema/allOf/0" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/paths/~1synthetic_line_items~1{uid}/get/responses/200/content/application~1json/schema" } } } } ] }, "examples": { "syntheticLineItems": { "value": { "total_count": 24, "count": 2, "limit": 2, "offset": 8, "data": [ { "uid": "mFCrAseYKrqzjoZS", "settled_index": 9, "transaction_uid": "YBHNH3BgykqrjLgz", "synthetic_account_uid": "4XkJnsfHsuqrxmeX", "status": "settled", "us_dollar_amount": "12.34", "running_us_dollar_balance": "42.98", "running_asset_balance": "0.35", "asset_quantity": "0.14", "asset_type": "AAPL", "closing_price": "12.50", "custodial_account_uid": "GHc5CjSM75pzBXMa", "custodial_account_name": "Brokerage Account", "description": "Credit from \"Clothing Branding installation\"", "created_at": "2019-10-14T03:21:53.301Z", "settled_at": "2019-10-17T00:01:53.681Z" }, { "uid": "j56aHgLBqkNu1KwK", "settled_index": 10, "transaction_uid": "YBHNH3BgykqrjLgz", "synthetic_account_uid": "exMDShw6yM3NHLYV", "status": "settled", "us_dollar_amount": "-12.34", "running_us_dollar_balance": "4.21", "running_asset_balance": "4.21", "asset_quantity": "-12.34", "asset_type": "USD", "closing_price": "12.50", "custodial_account_uid": "WPsSKYyKy9v4RQ6P", "custodial_account_name": "Checking Account", "description": "Debit to \"deposit architect hack\"", "created_at": "2019-10-14T03:21:53.301Z", "settled_at": "2019-10-17T00:01:53.682Z" } ] } } } } } } } } }, "/synthetic_line_items/{uid}": { "parameters": [ { "$ref": "#/paths/~1auth/parameters/0" }, { "$ref": "#/paths/~1pools~1{uid}/parameters/1" } ], "get": { "tags": [ "Transactions" ], "summary": "Get a single Synthetic Line Item", "description": "Retrieves a single Synthetic Line Item resource, including the amount, account, and associated Transaction Event.", "responses": { "200": { "description": "A single Synthetic Line Item is returned", "headers": { "x-trace-id": { "$ref": "#/paths/~1auth/post/responses/201/headers/x-trace-id" } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/paths/~1custodial_account_closing_balances~1{uid}/get/responses/200/content/application~1json/schema/allOf/0" }, { "type": "object", "properties": { "settled_index": { "type": "integer", "description": "A unique index that indicates the order in which the Synthetic Line Items were settled\n", "example": 9 }, "transaction_uid": { "type": "string", "example": "SMwKC1osz77DTEiu", "description": "UID of the Transaction this Synthetic Line Item belongs to" }, "synthetic_account_uid": { "type": "string", "example": "Jy8degj6iv2QngLo", "description": "UID of the Synthetic Account this Synthetic Line Item is associated with" }, "status": { "type": "string", "enum": [ "settled" ], "description": "Other statuses such as `pending` will be available later" }, "us_dollar_amount": { "type": "string", "description": "The signed USD amount of this specific Synthetic Line Item", "example": "12.34" }, "running_us_dollar_balance": { "type": "string", "description": "The running balance after settlement for this specific Asset Type held within the Synthetic Account, expressed in US Dollars calculated using the asset price used for settlement.\n", "example": "42.98" }, "running_asset_balance": { "type": "string", "description": "The running balance after settlement for this specific Asset Type held within the Synthetic Account, expressed in units of the given asset type.\n", "example": "0.24" }, "asset_quantity": { "type": "string", "description": "The quantity of the specific asset type for this Synthetic Line Item", "example": "21.31" }, "asset_type": { "type": "string", "description": "The type of asset for this Synthetic Line Item", "example": "USD" }, "closing_price": { "type": "string", "description": "If this Synthetic Line Item involves a security purchase/sale the USD value at the time of the purchase/sale\n", "example": "25.00" }, "custodial_account_name": { "type": "string", "description": "The name of the Custodial Account associated with this Synthetic Line Item", "example": "Main Checking" }, "custodial_account_uid": { "type": "string", "description": "The UID of the Custodial Account associated with this Synthetic Line Item", "example": "AM8Ai6JtuoE3Jgfr" }, "description": { "type": "string", "description": "Human-readable description in context of Synthetic Accounts", "example": "Transfer from Synthetic Account 1 to Synthetic Account 2" }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time when the Synthetic Line Item is first recognized by Newline. This may be when the Transfer is initiated if the Synthetic Line Item is associated with one.\n", "example": "2019-10-15T15:53:13.591Z" }, "settled_at": { "type": "string", "format": "date-time", "description": "The date and time when the Synthetic Line Item is settled", "example": "2019-10-16T12:51:12.673Z" } } } ] }, "examples": { "syntheticLineItem": { "value": { "uid": "j56aHgLBqkNu1KwK", "settled_index": 10, "transaction_uid": "YBHNH3BgykqrjLgz", "synthetic_account_uid": "exMDShw6yM3NHLYV", "status": "settled", "us_dollar_amount": "-12.34", "running_us_dollar_balance": "4.21", "running_asset_balance": "4.21", "asset_quantity": "-12.34", "asset_type": "USD", "closing_price": "12.50", "custodial_account_uid": "WPsSKYyKy9v4RQ6P", "custodial_account_name": "Checking Account", "description": "Debit to \"deposit architect hack\"", "created_at": "2019-10-14T03:21:53.301Z", "settled_at": "2019-10-17T00:01:53.682Z" } } } } } } } } } } } ```` # Sibling pages * [List Transactions](https://developers.newline53.com/newline/reference/get_transactions.md) * [Get a single Transaction](https://developers.newline53.com/newline/reference/get_transactions-uid.md) * [Approve or deny a transaction](https://developers.newline53.com/newline/reference/put_transactions-uid-authorize.md) * [List Transaction Events](https://developers.newline53.com/newline/reference/get_transaction-events.md) * [Get a single Transaction Event](https://developers.newline53.com/newline/reference/get_transaction-events-uid.md) * [Get a single Synthetic Line Item](https://developers.newline53.com/newline/reference/get_synthetic-line-items-uid.md) * [List Custodial Line Items](https://developers.newline53.com/newline/reference/get_custodial-line-items.md) * [Get a single Custodial Line Item](https://developers.newline53.com/newline/reference/get_custodial-line-items-uid.md) * [Transaction Statuses and Types](https://developers.newline53.com/newline/reference/transaction-statuses-and-transaction-types.md)