Terminology
The terms, which represent API resource objects in Newline, below are referenced in our API documentation and endpoint definitions.
Some important notes while reading through this list:
Resource 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.
Certain 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).
While Resource Objects are distinct, they, in some cases, can represent the same entity.
- Ex. 1 - Clients can also be Customers if they manage and own the financial products in question.
- Ex. 2 - Transfers produce Transactions, but the produced Transactions (in aggregate) represent the original money movement.
Term | Definition |
---|---|
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. |
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. |
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 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 section below. |
Partner | Any infrastructure partner integrated within the Newline Platform. |
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. |
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. |
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. |
Service Offering | The financial product offered by the Newline platform. These can be (but are not limited to) checking, savings, brokerage, or retirement accounts. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
Please note that the terminology and error codes used in the Newline Platform Overview Guides differ from those found in the Card Issuing Sponsorship Guides.
While both sets of documentation pertain to related services, they employ distinct naming conventions and error code formats. As such when referring to either guide, ensure that you are using the appropriate definitions and error codes specific to the guide in question to avoid any confusion or misapplication of information.
Updated about 2 months ago