openapi: 3.2.0 info: title: Newline Platform Transactions 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. |" servers: - url: https://sandbox.newline53.com/api/v1 security: - ApiKeyAuth: [] tags: - 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: /transactions: parameters: - $ref: '#/paths/~1auth/parameters/0' get: tags: - Transactions summary: List Transactions description: Retrieves a list of Transactions. Transactions representing expired authorizations or expired reversals are suppressed by default. parameters: - $ref: '#/paths/~1pools/get/parameters/0' - $ref: '#/paths/~1transfers/get/parameters/2' - name: source_synthetic_account_uid in: query schema: type: string example: 4XkJnsfHsuqrxmeX description: 'Filter by source Synthetic Account. Multiple values are allowed, e.g. `source_synthetic_account_uid[]=4XkJnsfHsuqrxmeX&source_synthetic_account_uid[]=aeD4RMVyTKaspEzj`. ' - name: destination_synthetic_account_uid in: query schema: type: string example: exMDShw6yM3NHLYV description: 'Filter by destination Synthetic Account. Multiple values are allowed, e.g. `destination_synthetic_synthetic_uid[]=exMDShw6yM3NHLYV&destination_synthetic_account_uid[]=1WVbRrp1s1MvTaAe`. ' - name: synthetic_account_uid in: query schema: type: string example: 4XkJnsfHsuqrxmeX description: 'Filter by Synthetic Account, source or destination. Multiple values are allowed, e.g. `synthetic_account_uid[]=4XkJnsfHsuqrxmeX&synthetic_account_uid[]=exMDShw6yM3NHLYV`. ' - name: type in: query schema: type: string enum: - ach - ach_return - atm_withdrawal - book_transfer - card_load - card_purchase - card_refund - cash_load - corporate_action - credit - denied_authorization - dispute - fee - instant_payment - interest - other - peer_to_peer_transfer - reversal - reversed_transfer - wire example: ach description: 'Filter by type. Multiple values are allowed, e.g. `type[]=dispute&type[]=fee`. ' - name: has_return in: query schema: type: boolean example: true description: 'Filter by return. Only transactions that have returns (present or absend) to be included in the results. ' - name: show_denied_auths in: query schema: type: boolean example: true description: 'Causes transactions with a status of `denied` (suppressed by default) to be included in the results. ' - name: show_expired in: query schema: type: boolean example: true description: 'Causes transactions with a status of `expired` (suppressed by default) to be included in the results. ' - name: status in: query schema: type: string enum: - canceled - queued - pending - settled - failed - expired - denied description: 'Filter by status. Multiple values are allowed, e.g. `status[]=queued&status[]=pending`. ' - name: search_description in: query schema: type: string example: Transfer* description: 'Attempts to search for the provided string in the description field. ''*'' can be used as a wildcard at the beginning or end of the string. Any record with a match will be returned. ' - name: include_zero in: query schema: type: boolean example: true description: 'Causes transactions with a `us_dollar_amount = 0` (suppressed by default) to be included in the results. ' - $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 - id_asc - id_desc - settled_index_asc - settled_index_desc - us_dollar_amount_asc - us_dollar_amount_desc - name: created_at_after in: query schema: $ref: '#/paths/~1transactions/get/parameters/17/schema' description: 'Return only results with `created_at` after the provided ISO 8601 date or timestamp ' - name: created_at_before in: query schema: $ref: '#/paths/~1transactions/get/parameters/17/schema' description: 'Return only results with `created_at` before the provided ISO 8601 date or timestamp ' - name: settled_at_after in: query schema: type: string format: date-time example: '2020-01-01T00:00:00Z' description: 'Return only transactions with `settled_at` after the provided ISO 8601 timestamp ' - name: settled_at_before in: query schema: $ref: '#/paths/~1transactions/get/parameters/17/schema' description: 'Return only transactions with `settled_at` before the provided ISO 8601 timestamp ' - name: initial_action_at_after in: query schema: $ref: '#/paths/~1transactions/get/parameters/17/schema' description: 'Return only transactions with `initial_action_at` after the provided ISO 8601 timestamp ' - name: initial_action_at_before in: query schema: $ref: '#/paths/~1transactions/get/parameters/17/schema' description: 'Return only transactions with `initial_action_at` before the provided ISO 8601 timestamp ' - name: settled_index_after in: query schema: type: integer example: 123 description: 'Return only transactions with `settled_index` after the provided value ' - name: settled_index_before in: query schema: type: integer example: 123 description: 'Return only transactions with `settled_index` before the provided value ' - name: id_after in: query schema: type: integer example: 123 description: 'Return only transactions with `id` after the provided value ' - name: id_before in: query schema: type: integer example: 123 description: 'Return only transactions with `id` before the provided value ' responses: '200': description: A list of Transactions 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: allOf: - $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: instant_payment: type: object description: 'Instant payment information. Only present if the Transaction is an instant payment. ' allOf: - $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/instant_payment/allOf/0' wire: type: object description: 'Wire-specific information. Only present if the Transaction is a wire. ' allOf: - allOf: - $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/wire/allOf/0/allOf/0/allOf/1' - $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/wire/allOf/0/allOf/1' - $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/1' - $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/wire/allOf/0/allOf/3' required: - counterparty_name ach: type: object description: 'ACH-specific information. Only present if the Transaction is an ACH. The optional `iat` object within `ach` contains details for International ACH Transactions. It is only included if `iat_ach_display_enabled` is set to `true` for the program and the transaction contains IAT data. ' allOf: - allOf: - $ref: '#/paths/~1transfers/post/responses/201/content/application~1json/schema/allOf/0/allOf/3/properties/ach/allOf/0' - type: object properties: ach_return_code: $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/ach/allOf/0/allOf/1/properties/ach_return_code' ach_return_reason: $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/ach/allOf/0/allOf/1/properties/ach_return_reason' noc_code: $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/ach/allOf/0/allOf/1/properties/noc_code' noc_reason: $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/ach/allOf/0/allOf/1/properties/noc_reason' transfer_trace_id: $ref: '#/paths/~1transfers/post/responses/201/content/application~1json/schema/allOf/1/properties/ach/allOf/0/allOf/1/properties/transfer_trace_id' originator_routing_number: $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/ach/allOf/0/allOf/1/properties/originator_routing_number' counterparty_name: type: string description: Counterparty name. iat: $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/ach/allOf/0/allOf/1/properties/iat' - $ref: '#/paths/~1transactions~1%7Buid%7D~1authorize/put/responses/200/content/application~1json/schema' examples: transactions: value: total_count: 24 count: 8 limit: 8 offset: 1 data: - adjustment_uid: null customer_uid: Trzqy9t6j6tFGoG3 created_at: '2019-10-15T15:53:13.591Z' custodial_account_uids: - Gw4gr1T81YrvLT6M - 66gso857LyQWC6XN description: Transfer from "Bank ABC" to "Emergency Cupcake Funds" destination_synthetic_account_uid: 15gTLPAEzHxtSrU6 id: 27 initial_action_at: '2019-10-15T15:53:13.586Z' net_asset: positive return_uid: null settled_at: '2019-10-16T12:51:12.673Z' settled_index: 8 source_synthetic_account_uid: rJuYjZuLei2TZji9 statement_posted_at: '2019-10-17T00:01:53.682Z' status: settled transaction_batch_uid: '3' transaction_event_uids: - MB2yqBrm3c4bUbou transfer_uid: 1qVSAEjsV55vDZxX type: ach uid: SMwKC1osz77DTEiu us_dollar_amount: '5.21' virtual_reference_number_uid: null ach: originator_name: Mr. Original originator_routing_number: '123456789' company_id: ABC654 company_discretionary_data: Shhhh counterparty_name: Receiver Account Name prenote: false sec_code: CCD payment_type: S entry_description: Excellent entry service_processing: STANDARD effective_entry_date: '2023-12-12' id_number: 543-DEF ach_return_code: null ach_return_reason: null addenda: Oops, forgot to mention noc_code: C04 noc_reason: Bank account name change noc_corrected_data: Aaron Velazquez transfer_trace_id: A1Z2b3y4c5x6DW78 iat: foreign_exchange_indicator: FF foreign_exchange_reference_indicator: '3' foreign_exchange_reference: null iso_destination_country_code: US iso_originating_currency_code: USD iso_destination_currency_code: USD transaction_code: '22' transaction_type_code: MIS foreign_payment_amount: null foreign_trace_number: null originator_street_address: 410 TERRY AVENUE NORTH originator_city_state_province: SEATTLE*WA originator_country_postal_code: US*98109 odfi_name: BANK OF AMERICA NA odfi_identification_number_qualifier: '01' odfi_id: '121000358' odfi_branch_country_code: US rdfi_name: FIFTH THIRD BANK NATIONAL ASSOCIA rdfi_identification_number_qualifier: '01' rdfi_id: 071919133 rdfi_branch_country_code: US counterparty_street_address: 228 S BURNS counterparty_city_state_province: INDEPEDENCE*KS counterparty_country_postal_code: US*67301 payment_related_information_1: NTE*ADD*FCS003348198932 PAYMENT-NUM 351380\\NTE*ADD*601 POP GOODS AND SERVICES payment_related_information_2: null foreign_correspondent_banks: - name: BANK OF AMERICA CANADA id_number_qualifier: '01' id_number: '121000358' branch_country_code: CA - adjustment_uid: null customer_uid: Trzqy9t6j6tFGoG3 created_at: '2023-07-17T07:07:07.707Z' custodial_account_uids: - Gw4gr1T81YrvLT6M - 66gso857LyQWC6XN description: ACH return debited from 15gTLPAEzHxtSrU6 destination_synthetic_account_uid: rJuYjZuLei2TZji9 id: 40 initial_action_at: '2023-07-17T07:07:07.707Z' net_asset: negative return_uid: 9ZZ87saSFLkkDG7z settled_at: '2023-07-17T09:07:07.707Z' settled_index: 8 source_synthetic_account_uid: 15gTLPAEzHxtSrU6 statement_posted_at: '2019-10-17T00:01:53.682Z' status: settled transaction_batch_uid: '3' transaction_event_uids: - MB2yqBrm3c4bUbou transfer_uid: 1qVSAEjsV55vDZxX type: initiated_ach_return uid: SMwKC1osz77DTEiu us_dollar_amount: '5.21' virtual_reference_number_uid: null ach: ach_return_code: R02 ach_return_reason: Account closed addenda: TXN0055BADD1E cancelled company_discretionary_data: Shhhh company_id: ABC654ZY12 counterparty_name: Marge's Roofing Inc effective_entry_date: '2023-12-12' entry_description: Excellent entry id_number: 543-DEF noc_code: null noc_corrected_data: null noc_reason: null originator_name: Mr. Original originator_routing_number: '123456789' payment_type: S prenote: false sec_code: CCD service_processing: STANDARD transfer_trace_id: A1Z2b3y4c5x6DW78 - adjustment_uid: null customer_uid: o1gSDeWvEt45Yuaa created_at: '2023-07-17T07:07:07.707Z' custodial_account_uids: - Jz1wjmm1cMyMkqmp description: Wire return debited from pA7zLNS3BtSADfDh destination_synthetic_account_uid: PK3hKtXsfsJ2pfGR id: 41 initial_action_at: '2023-07-17T07:07:07.707Z' net_asset: negative return_uid: 9ZZ87saSFLkkDG7z settled_at: '2023-07-17T09:07:07.707Z' settled_index: 8 source_synthetic_account_uid: pA7zLNS3BtSADfDh statement_posted_at: null status: pending transaction_batch_uid: null transaction_event_uids: [] transfer_uid: null type: initiated_wire_return uid: 67r1gjrkgvYBR6EX us_dollar_amount: '5595.00' virtual_reference_number_uid: null wire: counterparty_name: Ultimate Window Installers, counterparty_bank_address: line1: 101 Common St line2: null line3: Coxsackie NY 12051 US counterparty_bank_name: ACME Bank counterparty_bank_routing_number: '123456789' intermediary_bank_address: line1: 202 Another St line2: Calcium, NY 13616 line3: null intermediary_bank_name: General Bank of Calcium intermediary_bank_routing_number: '987654321' chips: null imad: 20240510NHXPVPQY232293 uetr: null - adjustment_uid: null customer_uid: szaxXExVVScwKqPT created_at: '2023-07-17T07:07:07.707Z' custodial_account_uids: - s5DQw78BKi5ye7CX - EffzWWZztHo4B3XM description: Sent RTP ID 20231004043000096P1BAAAA00041250796 to Rupert's Roofers of Raleigh destination_synthetic_account_uid: smfVbCVA4iqHUkUX id: 39 initial_action_at: '2023-07-17T07:07:07.707Z' net_asset: negative return_uid: null settled_at: '2023-07-17T09:07:07.707Z' settled_index: 10 source_synthetic_account_uid: H2uQrLRNAfQr3WLn statement_posted_at: '2019-10-17T00:01:53.682Z' status: settled transaction_batch_uid: '3' transaction_event_uids: - TzqSj2r6NN5MMYu9 transfer_uid: null type: instant_payment uid: 7PpuQuEz9FR8VeQt us_dollar_amount: '13500.45' virtual_reference_number_uid: rdPjBZeKfpGZgaT1 instant_payment: memo: For the 6/5/23 shipment of pineapple popsicles network_transaction_id: 20231004043000096P1BAAAA00041250796 network: fednow failure_code: null failure_reason: null counterparty_name: Marge's Roofing Inc counterparty_bank_name: East West Regional Bank counterparty_bank_routing_number: '123456789' counterparty_account_number_last_four: '3345' payment_id: BayleeStacy original_end_to_end_id: null, initiating_party_name: Rupert's Roofers of Raleigh transmitter_name: Rupert's Roofers of Raleigh counterparty_address: street_number: '456' street1: Oak Ave. street2: null city: Raleigh state: NC postal_code: '27601' country: US counterparty_bank_address: street_number: '789' street1: Bank Blvd. street2: null city: Raleigh state: NC postal_code: '27602' country: US   instant_payment_transmitter: name: Royalty Asset Management street_number: 123 street1: Abc St. city: Boring state: OR postal_code: 97009 - adjustment_uid: null customer_uid: Trzqy9t6j6tFGoG3 created_at: '2019-11-15T15:53:13.591Z' custodial_account_uids: - Jz1wjmm1cMyMkqmp - kchtGUEurq3U4Q3b description: Transfer from "Home Savings" to "Ultimate Window Installers Inc." destination_synthetic_account_uid: BUuRwEKGHkNEbDoF id: 32 initial_action_at: '2019-11-15T15:53:13.586Z' net_asset: positive return_uid: null settled_at: '2019-11-17T12:51:12.673Z' settled_index: 8 source_synthetic_account_uid: pA7zLNS3BtSADfDh statement_posted_at: '2019-10-17T00:01:53.682Z' status: settled transaction_batch_uid: '3' transaction_event_uids: - C2xRgpfdyqgbRoJs transfer_uid: LEbStJ7MFSniq18h type: wire uid: 67r1gjrkgvYBR6EX us_dollar_amount: '5595.00' virtual_reference_number_uid: null wire: counterparty_address: line1: 100 Common St line2: null line3: Coxsackie NY 12051 US counterparty_name: Ultimate Window Installers counterparty_bank_address: line1: 101 Common St line2: null line3: Coxsackie NY 12051 US counterparty_bank_name: ACME Bank counterparty_bank_routing_number: '123456789' intermediary_bank_address: line1: 202 Another St line2: Calcium, NY 13616 line3: null intermediary_bank_name: General Bank of Calcium intermediary_bank_routing_number: '987654321' chips: 1234567 imad: null uetr: null bank_to_bank_info: /DAS/REF:55555ZZ000ZZ originator_account_number_last_four: '1234' authorization: authorization_finalized_at: '2019-11-15T20:37:09.904Z' authorization_required_by: '2019-11-16T15:53:13.586Z' authorization_status: client_approved denied_memo: denied memo denied_reason: vrn_archived - adjustment_uid: null customer_uid: KrWPzr5PMQYJXpuY created_at: '2019-12-14T03:21:53.301Z' custodial_account_uids: - HbkmGjUZJsnRUnrB - Gw4gr1T81YrvLT6M - e3sEiUHmfEpt4NHM description: Transfer from "Clothing Branding installation" to "deposit architect hack" destination_synthetic_account_uid: exMDShw6yM3NHLYV id: 33 initial_action_at: '2019-12-14T03:21:53.295Z' net_asset: neutral return_uid: null settled_at: '2019-12-17T00:01:53.682Z' settled_index: 9 source_synthetic_account_uid: 4XkJnsfHsuqrxmeX statement_posted_at: '2019-10-17T00:01:53.682Z' status: settled transaction_batch_uid: '3' transaction_event_uids: - 26FR8BBPDG2AXXny - wRmMXSfZZr3igDnc transfer_uid: Q9qAuwpBQqhqv2Fy type: book_transfer uid: YBHNH3BgykqrjLgz us_dollar_amount: '12.34' virtual_reference_number_uid: null - adjustment_uid: AP8tE12ewjXFq6eL customer_uid: pRWHTjprnfdSzKW6 created_at: '2021-10-14T03:21:53.301Z' custodial_account_uids: - n6XxSDyFZbNiV9JM description: Credit for Loyalty Rewards destination_synthetic_account_uid: smfVbCVA4iqHUkUX id: 37 initial_action_at: '2021-10-14T03:21:53.297Z' net_asset: negative return_uid: null settled_at: '2021-10-17T00:01:53.682Z' settled_index: 10 source_synthetic_account_uid: P2uQrLRNAfQr3WLn status: settled transaction_event_uids: - azEYV4F1gm7VB5NE transfer_uid: null type: credit uid: pvNS1sN5Y5chbRdy us_dollar_amount: '2.50' virtual_reference_number_uid: null - adjustment_uid: null customer_uid: pRWHTjprnfdSzKW6 created_at: '2021-10-14T03:21:53.301Z' custodial_account_uids: - n6XxSDyFZbNiV9JM description: 302 - BOB'S WIDGETS SPRINGFIELD, VA destination_synthetic_account_uid: smfVbCVA4iqHUkUX id: 38 initial_action_at: '2021-10-14T03:21:53.297Z' net_asset: negative return_uid: null settled_at: '2021-10-17T00:01:53.682Z' settled_index: 10 source_synthetic_account_uid: P2uQrLRNAfQr3WLn status: settled transaction_event_uids: - 5rxwPFs76WEb8Apu transfer_uid: null type: card_purchase uid: 7PpuQuEz9FR8VeQt us_dollar_amount: '3.50' virtual_reference_number_uid: null transactions_with_denials: value: total_count: 24 count: 7 limit: 7 offset: 0 data: - adjustment_uid: AP8tE12ewjXFq6eL created_at: '2022-06-03T03:21:53.301Z' custodial_account_uids: - a8XxSDyFZbNiV9JM debit_card_uid: ahorg2Cw6WJCRLaP denial_reason: inactive_card description: 302 - BOB'S WIDGETS SPRINGFIELD, VA destination_synthetic_account_uid: amfVbCVA4iqHUkUX id: 30 initial_action_at: '2022-06-03T03:21:53.297Z' mcc: '1200' merchant_location: SPRINGFIELD VA merchant_name: BOB'S WIDGETS merchant_number: '010000034261221' net_asset: neutral settled_at: null settled_index: null source_synthetic_account_uid: A2uQrLRNAfQr3WLn status: denied transaction_event_uids: null transfer_uid: null type: card_purchase uid: 1PpuQuEz9FR8VeQt us_dollar_amount: '0' - adjustment_uid: BP8tE12ewjXFq6eL created_at: '2022-06-04T03:21:53.301Z' custodial_account_uids: - b8XxSDyFZbNiV9JM debit_card_uid: bhorg2Cw6WJCRLaP denial_reason: insufficient_funds description: 302 - BOB'S WIDGETS SPRINGFIELD, VA destination_synthetic_account_uid: bmfVbCVA4iqHUkUX id: 31 initial_action_at: '2022-06-04T03:21:53.297Z' mcc: '2200' merchant_location: SPRINGFIELD VA merchant_name: BOB'S WIDGETS merchant_number: '020000034261221' net_asset: neutral settled_at: null settled_index: null source_synthetic_account_uid: B2uQrLRNAfQr3WLn status: denied transaction_event_uids: null transfer_uid: null type: card_purchase uid: 2PpuQuEz9FR8VeQt us_dollar_amount: '0' - adjustment_uid: CP8tE12ewjXFq6eL created_at: '2021-10-05T03:21:53.301Z' custodial_account_uids: - c6XxSDyFZbNiV9JM debit_card_uid: iporg2Cw6WJCRLaP denial_reason: insufficient_funds_gas description: 302 - BOB'S WIDGETS SPRINGFIELD, VA destination_synthetic_account_uid: smfVbCVA4iqHUkUX id: 32 initial_action_at: '2021-10-05T03:21:53.297Z' mcc: '3200' merchant_location: SPRINGFIELD VA merchant_name: BOB'S WIDGETS merchant_number: '030000034261221' net_asset: positive settled_at: null settled_index: null source_synthetic_account_uid: C2uQrLRNAfQr3WLn status: denied transaction_event_uids: null transfer_uid: null type: card_purchase uid: 3PpuQuEz9FR8VeQt us_dollar_amount: '3.50' - adjustment_uid: DT8tE12ewjXFq6eL created_at: '2022-06-06T03:21:53.301Z' custodial_account_uids: - d8XxSDyFZbNiV9JM debit_card_uid: dhorg2Cw6WJCRLaP denial_reason: invalid_pin description: 302 - BOB'S WIDGETS SPRINGFIELD, VA destination_synthetic_account_uid: smfVbCVA4iqHUkUX id: 33 initial_action_at: '2022-06-06T03:21:53.297Z' mcc: '4200' merchant_location: SPRINGFIELD VA merchant_name: BOB'S WIDGETS merchant_number: '040000034261221' net_asset: positive settled_at: null settled_index: null source_synthetic_account_uid: D2uQrLRNAfQr3WLn status: denied transaction_event_uids: null transfer_uid: null type: card_purchase uid: 4PpuQuEz9FR8VeQt us_dollar_amount: '13.50' - adjustment_uid: EP8tE12ewjXFq6eL created_at: '2022-06-07T03:21:53.301Z' custodial_account_uids: - e8XxSDyFZbNiV9JM debit_card_uid: ehorg2Cw6WJCRLaP denial_reason: network_unavailable description: 302 - BOB'S WIDGETS SPRINGFIELD, VA destination_synthetic_account_uid: smfVbCVA4iqHUkUX id: 34 initial_action_at: '2022-06-07T03:21:53.297Z' mcc: '5200' merchant_location: SPRINGFIELD VA merchant_name: BOB'S WIDGETS merchant_number: '050000034261221' net_asset: positive settled_at: null settled_index: null source_synthetic_account_uid: E2uQrLRNAfQr3WLn status: denied transaction_event_uids: null transfer_uid: null type: card_purchase uid: 5PpuQuEz9FR8VeQt us_dollar_amount: '22.80' - adjustment_uid: FP8tE12ewjXFq6eL created_at: '2022-06-08T03:21:53.301Z' custodial_account_uids: - f8XxSDyFZbNiV9JM debit_card_uid: fhorg2Cw6WJCRLaP denial_reason: other description: 302 - BOB'S WIDGETS SPRINGFIELD, VA destination_synthetic_account_uid: fmfVbCVA4iqHUkUX id: 35 initial_action_at: '2022-06-08T03:21:53.297Z' mcc: '6200' merchant_location: SPRINGFIELD VA merchant_name: BOB'S WIDGETS merchant_number: '060000034261221' net_asset: positive settled_at: null settled_index: null source_synthetic_account_uid: F2uQrLRNAfQr3WLn status: denied transaction_event_uids: null transfer_uid: null type: card_purchase uid: 6PpuQuEz9FR8VeQt us_dollar_amount: '50.50' - adjustment_uid: null created_at: '2019-10-14T03:21:53.301Z' custodial_account_uids: - HbkmGjUZJsnRUnrB - Gw4gr1T81YrvLT6M - e3sEiUHmfEpt4NHM debit_card_uid: null denial_reason: null description: Transfer from "Clothing Branding installation" to "deposit architect hack" destination_synthetic_account_uid: exMDShw6yM3NHLYV id: 36 initial_action_at: '2019-10-14T03:21:53.295Z' mcc: null merchant_location: null merchant_name: null merchant_number: null net_asset: positive settled_at: '2019-10-17T00:01:53.682Z' settled_index: 9 source_synthetic_account_uid: 4XkJnsfHsuqrxmeX status: settled transaction_event_uids: - 26FR8BBPDG2AXXny - wRmMXSfZZr3igDnc transfer_uid: Q9qAuwpBQqhqv2Fy type: book_transfer uid: YBHNH3BgykqrjLgz us_dollar_amount: '12.34' /transactions/{uid}: parameters: - $ref: '#/paths/~1auth/parameters/0' - $ref: '#/paths/~1pools~1%7Buid%7D/parameters/1' get: tags: - Transactions summary: Get a single Transaction description: Retrieves a single Transaction resource along with its details, including amount, origin, destination, and status. responses: '200': description: A single Transaction is returned headers: x-trace-id: $ref: '#/paths/~1auth/post/responses/201/headers/x-trace-id' content: application/json: schema: allOf: - allOf: - $ref: '#/paths/~1transaction_events~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: id: type: integer description: 'An index, distinct from a Transaction''s uid, that indicates the order in which the Transactions were created. ' example: 233 adjustment_uid: type: - string - 'null' description: The UID of the Adjustment this Transaction is associated with, if any. example: rLS9K7uqqgdEqBu4 customer_uid: type: string description: The unique id of the Customer associated with the Transaction. example: 6UYRjzgguXjjKDtK created_at: type: string format: date-time description: 'The date and time when the Transaction is first recognized by Newline. This may be when the Transfer is initiated if the Transaction is associated with one. ' example: '2019-10-14T03:21:53.301Z' custodial_account_uids: type: array description: 'A list of unique ids referring to Custodial Accounts that are currently involved in this Transaction. An empty array will be returned if there are no Custodial Accounts involved. The array may contain more values as the Transaction progresses and will no longer grow when its status becomes settled. The array may still be empty by the time the Transaction is settled if there is no custodial asset movement as a result of this Transaction. ' items: type: string example: - 66gso857LyQWC6XN - Gw4gr1T81YrvLT6M description: type: string description: Description provided to the Transaction during origination example: Transfer from "Clothing Branding installation" to "deposit architect hack" destination_synthetic_account_uid: type: string example: exMDShw6yM3NHLYV description: Synthetic Account where the asset has landed initial_action_at: type: string format: date-time description: 'The date and time of some action (e.g. a debit authorization) that resulted in this Transaction''s creation. When relevant and available, this value is a timestamp received by and generated externally to Newline; otherwise, this value will be when a transaction request was received and virtually identical to `created_at` ' example: '2019-10-14T03:21:53.301Z' net_asset: type: string enum: - positive - negative - neutral example: positive description: 'Indicates whether the Customer''s asset has gone up (`positive`), gone down (`negative`) or stayed the same (`neutral`) as a result of this Transaction. ' return_uid: type: - string - 'null' description: 'The uid of a related Return, when applicable. ' example: Fnf9cbheYhkTkais settled_at: type: string format: date-time description: The date and time when the Transaction is settled example: '2019-10-17T00:01:53.682Z' settled_index: type: - integer - 'null' description: 'Another unique index that indicates the order in which the Transactions were settled. Null if the Transaction''s status is queued or pending. ' example: 23 source_synthetic_account_uid: type: string example: 4XkJnsfHsuqrxmeX description: Synthetic Account from where the asset is pulled statement_posted_at: type: - string - 'null' format: date-time description: The date and time when the statement was posted example: '2019-10-17T00:01:53.682Z' status: type: string enum: - canceled - queued - pending - settled - failed - denied - expired example: settled description: 'When a Transfer is created via [POST /transfers](/reference/post_transfers), an associated Transaction is created with status `queued`. If it involves at least one custodial transfer, once the custodial transfer is initiated, the status will transition to `pending`. Once a Transaction is settled, whether it has asset movement in custodial level, or is synthetic-only, or is RDFI (Receiving Depository Financial Institution, meaning no Newline Transfer was associated), it will have a `settled` status. ' transaction_batch_uid: type: - string - 'null' example: '4' description: The unique id of the Transaction Batch this Transaction is associated with, if any. transaction_event_uids: type: array description: 'A list of unique ids referring to Transaction Events belonging to this Transaction. An empty array will be returned if there is no event involved. The array may contain more values as the Transaction progresses and will no longer grow when its status becomes settled. The array may still be empty at the time the Transaction is settled if there is no custodial asset movement as a result of this Transaction. ' items: type: string example: - MB2yqBrm3c4bUbou - qCEEyGQw73Ajn3WZ transfer_uid: type: - string - 'null' description: The unique id of the Transfer this Transaction is associated with, if any. example: rLS9K7uqqgdEqBu4 type: type: string enum: - ach - ach_return - atm_withdrawal - book_transfer - card_load - card_purchase - card_refund - cash_load - corporate_action - credit - denied_authorization - dispute - fee - initiated_ach_return - initiated_ach_reversal - initiated_wire_return - instant_payment - interest - other - peer_to_peer_transfer - reversal - reversed_transfer - set_account_balance - wire example: ach description: 'Transactions are categorized by Type. See the Transaction Statuses and Transaction Types section below for a list and definition of each Transaction Type that Newline supports. ' us_dollar_amount: type: string example: '12.34' description: 'The amount of the Transaction in question. The amount will never be negative, please refer to the net_asset field for direction (i.e., credit or debit). ' virtual_reference_number_uid: type: string example: null description: 'The VRN uid, when the transaction was processed using a VRN. ' - type: object properties: instant_payment: description: 'Instant payment information. Only present if the Transaction is an instant payment. ' allOf: - type: object properties: network_transaction_id: type: string description: 'For newline initiated instant payments, a unique newline trace ID assigned to the transaction. For externally initiated instant payments, a unique transaction ID assigned by the network facilitating the instant payment. ' example: ca5690da-f0f4-4ca1-acb0-1edb1ae41bd3 network: type: string description: 'The network on which the instant payment was executed ' example: fednow failure_code: type: string description: 'A code indicating failure reason. It will only appear if transaction status is `failed` ' example: ERR100 failure_reason: type: string description: 'A description of why the transaction failed. It will only appear if transaction status is `failed` ' example: Account number invalid or missing counterparty_name: type: string description: 'Name of the business or individual who owns the counterparty Account. ' example: Marge's Roofing Inc counterparty_bank_name: type: string example: East West Regional Bank description: 'Name of the financial institution where the counterparty account is held. ' counterparty_bank_routing_number: description: 'The routing number associated with the counterparty bank account. ' allOf: - $ref: '#/paths/~1virtual_reference_numbers/post/requestBody/content/application~1json/schema/properties/routing_number/allOf/0' counterparty_account_number_last_four: type: string description: 'Last four digits of counterparty account number ' example: '3345' payment_id: type: string description: 'An originator-defined value. For RTP transactions, this will be the End-to-End ID. ' example: BayleeStacy original_end_to_end_id: type: - string - 'null' description: 'This field is currently always null. ' example: 'null' transmitter_name: type: string description: 'Name of the initiating counterparty. Deprecated in favor of `initiating_party_name`. ' example: Marge's Roofing Inc initiating_party_name: type: string description: 'Name of the initiating counterparty. ' example: Marge's Roofing Inc instant_payment_transmitter: description: 'Name and address of the Transmitter. ' allOf: - type: object properties: name: description: 'Name of the Transmitter. ' maxLength: 140 type: string example: Marthas Bank pattern: '[a-zA-Z0-9-_|]{1,140}$' required: - name - $ref: '#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/instant_payment/properties/instant_payment_transmitter/allOf/1' counterparty_bank_address: description: 'Address of the financial institution where the external account is held. ' type: - object - 'null' allOf: - $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/1' - type: object properties: memo: $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/memo/allOf/0' counterparty_address: description: 'Address of the business or individual who owns the external account. ' type: - object - 'null' allOf: - $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/1' wire: type: object description: 'Wire-specific information. Only present if the Transaction is a wire. ' allOf: - allOf: - allOf: - type: object properties: counterparty_address: type: - object - 'null' description: 'Address of the business or individual who owns the external account. ' allOf: - type: object properties: line1: type: string maxLength: 35 description: Part of an unparsed address. Data may vary or be null. example: 123 Abc St. line2: type: string maxLength: 35 description: Part of an unparsed address. Data may vary or be null. example: Boring, Oregon 97009 line3: type: string maxLength: 35 description: Part of an unparsed address. Data may vary or be null. example: null example: line1: 234 Xyz Rd APT 5 line2: Boston, MA line3: 2110 - allOf: - type: object properties: counterparty_name: description: 'Name of the business or individual who owns the counterparty Account. ' allOf: - $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_name/allOf/0' counterparty_bank_address: type: - object - 'null' description: 'Address of the financial institution where the external account is held. ' allOf: - $ref: '#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/wire/allOf/0/allOf/0/allOf/0/properties/counterparty_address/allOf/0' counterparty_bank_name: type: - string - 'null' description: 'Name of the financial institution where the counterparty account is held. ' allOf: - $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_bank_name/allOf/0' - type: object properties: counterparty_bank_routing_number: description: 'The routing number associated with the counterparty bank account. ' allOf: - $ref: '#/paths/~1virtual_reference_numbers/post/requestBody/content/application~1json/schema/properties/routing_number/allOf/0' - allOf: - type: object properties: intermediary_bank_address: description: 'Address of the intermediary bank. To be populated if an intermediary bank is required to execute the wire transfer. ' example: line1: 345 Def Ave line2: San Francisco line3: CA 94016 country: US allOf: - $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/0' intermediary_bank_name: description: 'Name of the intermediary bank, when applicable. For wires only. Maximum 35 characters. ' allOf: - $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/intermediary_bank_name/allOf/0' intermediary_bank_routing_number: description: 'The ABA routing number associated with the intermediary bank involved in the wire transfer. This value is required if intermediary_bank_name or intermediary_bank_address is present; optional otherwise ' allOf: - $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/intermediary_bank_routing_number/allOf/0' - $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/1' - type: object properties: bank_to_bank_info: description: 'Transaction reference or confirmation number. ' type: - string - 'null' example: /DAS/REF:55555ZZ000ZZ originator_account_number_last_four: description: 'Last four digits of originator account number. ' type: - string - 'null' example: '1234' - type: object properties: wire_instructions: $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/wire_instructions/allOf/0' required: - counterparty_name ach: type: object description: 'ACH-specific information. Only present if the Transaction is an ACH. The optional `iat` object within `ach` contains details for International ACH Transactions. It is only included if `iat_ach_display_enabled` is set to `true` for the program and the transaction contains IAT data. ' allOf: - allOf: - $ref: '#/paths/~1transfers/post/responses/201/content/application~1json/schema/allOf/0/allOf/3/properties/ach/allOf/0' - type: object properties: ach_return_code: type: string description: ACH return code, pulled from the Return File ach_return_reason: type: string description: ACH return reason, pulled from the Return File addenda: $ref: '#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/addenda/allOf/0' noc_code: type: string description: 'Notification of Change (NOC) code, returned from the RDFI (Receiving Depository Financial Institution). ' noc_corrected_data: type: string description: 'Notification of Change (NOC) corrected data description, returned from the RDFI (Receiving Depository Financial Institution). ' noc_reason: type: string description: 'Notification of Change (NOC) description, returned from the RDFI (Receiving Depository Financial Institution). ' transfer_trace_id: $ref: '#/paths/~1transfers/post/responses/201/content/application~1json/schema/allOf/1/properties/ach/allOf/0/allOf/1/properties/transfer_trace_id' originator_routing_number: type: string description: 'Routing Number of individual or business originating the ACH transfer. ' example: '123456789' counterparty_name: type: string description: Counterparty name. iat: type: object description: International ACH Transaction (IAT) details. properties: foreign_exchange_indicator: type: string description: 'Identifies if the currency of the transaction changes. The Newline API supports the following values: - `FF` - Fixed to Fixed - `FV` - Fixed to Variable ' example: FF foreign_exchange_reference_indicator: type: string description: 'Defines the type of value in the "foreign_exchange_reference" field. The Newline API supports the following values: - `"1"` - Foreign Exchange Rate - `"2"` - Foreign Exchange Reference Number - `"3"` - If Foreign Exchange Indicator is "FF" ' example: '3' foreign_exchange_reference: type: string description: If "foreign_exchange_indicator" is "FF" then this field blank; otherwise it will contain either the foreign exchange rate used to execute the foreign exchange conversion or another reference to the foreign exchange transaction. iso_destination_country_code: type: string description: Country code of the destination country. example: US iso_originating_currency_code: type: string description: Currency code for transaction origination currency. example: USD iso_destination_currency_code: type: string description: Currency code for transaction destination currency. example: USD transaction_code: type: string description: 'Transaction code describing a debit or credit and the account type used in the payment. Payment transaction code requirements differ based on the receiving country. ' example: '22' transaction_type_code: type: string description: 'Identifies the IAT Transaction Type Code. The Newline API supports the following values: - `"ANN"` (Annuity) - `"RLS"` (Rent/Lease) - `"POS"` (Point of Sale Entry) - `"BUS"` (Business/Commercial) - `"SAL"` (Salary/Payroll) - `"RCK"` (Re-presented Check Entry) - `"DEP"` (Deposit) - `"TAX"` (Tax) - `"SHR"` (Shared Network Transaction) - `"LOA"` (Loan) - `"TEL"` (Telephone-Initiated Entry) - `"MIS"` (Miscellaneous) - `"ARC"` (Accounts Receivable Entry) - `"WEB"` (Internet-Initiated Entry) - `"MOR"` (Mortgage) - `"BOC"` (Back Office Conversion Entry) - `"PEN"` (Pension) - `"MTE"` (Machine Transfer Entry) - `"REM"` (Remittance) - `"POP"` (Point of Purchase Entry) ' example: MIS foreign_payment_amount: type: string description: The value of the funds if the destination currency code is different from destination country code. foreign_trace_number: type: string description: Optional trace number that can be supplied by the originator. originator_street_address: type: string description: "The street address of the originator. On received IATs, \nthis is the originator's street address supplied with the received payment.\n" example: 410 TERRY AVENUE NORTH originator_city_state_province: type: string description: "The city and, if applicable, the state or province of the Originator. \nAn asterisk (*) will separate the two values in this field.\n" example: SEATTLE*WA originator_country_postal_code: type: string description: "The two-character alphabetic country code, as defined within the ISO 3166-1-alpha-2 code list, \nand the postal code of the Originator. An asterisk (*) will separate the two values in this field.\n" example: US*98109 odfi_name: type: string description: The name of the ODFI. example: BANK OF AMERICA NA odfi_identification_number_qualifier: type: string description: 'A 2-digit code that identifies the type of ID in the "odfi_id" field. The Newline API supports the following values: - `"01"` - National Clearing System Number - `"02"` - BIC Code - `"03"` - IBAN ' example: '01' odfi_id: type: string description: The bank identification number of the DFI at which the Originator maintains their account. example: '121000358' odfi_branch_country_code: type: string description: Country code of the ODFI. example: US rdfi_name: type: string description: The name of the RDFI. example: FIFTH THIRD BANK NATIONAL ASSOCIA rdfi_identification_number_qualifier: type: string description: 'A 2-digit code that identifies the type of ID in the "rdfi_id" field. The Newline API supports the following values: - `"01"` - National Clearing System Number - `"02"` - BIC Code - `"03"` - IBAN ' example: '01' rdfi_id: type: string description: The bank identification number of the DFI at which the Receiver maintains his account. example: 071919133 rdfi_branch_country_code: type: string description: Country code of the RDFI. Will always be US for domestic IAT transactions example: US counterparty_street_address: type: string description: The street address of the Receiver. example: 228 S BURNS counterparty_city_state_province: type: string description: "The city and, if applicable, the state or province of the Receiver. \nAn asterisk (*) will separate the two values in this field.\n" example: INDEPEDENCE*KS counterparty_country_postal_code: type: string description: "The two-character alphabetic country code, as defined within the ISO 3166-1-alpha-2 code list, \nand the postal code of the Receiver. An asterisk (*) will separate the two values in this field.\n" example: US*67301 payment_related_information_1: type: string description: "The payment related information found in the remitance information addenda when provided. \nWhen the payment related information for an IAT Entry includes the identification of a country, \nthat country must be identified using that country's two-character alphabetic country code, \nas defined within the ISO 3166-1-alpha-2 code list.\n\nAn asterisk (\"*\") will be used as the delimiter between the data elements in the field.\n" example: NTE*ADD*FCS003348198932 PAYMENT-NUM 351380\NTE*ADD*601 POP GOODS AND SERVICES payment_related_information_2: type: string description: "The payment related information found in the remitance information addenda when provided. \nWhen the payment related information for an IAT Entry includes the identification of a country, \nthat country must be identified using that country's two-character alphabetic country code, \nas defined within the ISO 3166-1-alpha-2 code list.\n\nAn asterisk (\"*\") will be used as the delimiter between the data elements in the field.\n" foreign_correspondent_banks: type: array description: List of foreign correspondent banks involved in the IAT transaction. items: type: object properties: name: type: string description: The name of the Foreign Correspondent Bank when provided example: BANK OF AMERICA CANADA id_number_qualifier: type: string description: 'A 2-digit code that identifies the type of ID in the "id_number" field when provided. The Newline API supports the following values: - `"01"` - National Clearing System Number - `"02"` - BIC Code - `"03"` - IBAN ' example: '01' id_number: type: string description: The bank identification number of the Foreign Correspondent Bank when provided example: '121000358' branch_country_code: type: string description: A two-character alphabetic country code to identify the country in which the branch of the Foreign Correspondent Bank is located when provided. example: CA - $ref: '#/paths/~1transactions~1%7Buid%7D~1authorize/put/responses/200/content/application~1json/schema' examples: ach_transaction: value: adjustment_uid: null customer_uid: Trzqy9t6j6tFGoG3 created_at: '2019-10-15T15:53:13.591Z' custodial_account_uids: - Gw4gr1T81YrvLT6M - 66gso857LyQWC6XN description: Transfer from "Bank ABC" to "Emergency Cupcake Funds" destination_synthetic_account_uid: 15gTLPAEzHxtSrU6 id: 27 initial_action_at: '2019-10-15T15:53:13.586Z' net_asset: positive return_uid: null settled_at: '2019-10-16T12:51:12.673Z' settled_index: 8 source_synthetic_account_uid: rJuYjZuLei2TZji9 statement_posted_at: '2019-10-17T00:01:53.682Z' status: settled transaction_batch_uid: '3' transaction_event_uids: - MB2yqBrm3c4bUbou transfer_uid: 1qVSAEjsV55vDZxX type: ach uid: SMwKC1osz77DTEiu us_dollar_amount: '5.21' virtual_reference_number_uid: null ach: originator_name: Mr. Original originator_routing_number: '123456789' company_id: ABC654 company_discretionary_data: Shhhh counterparty_name: Receiver Account Name prenote: false sec_code: CCD payment_type: S entry_description: Excellent entry service_processing: STANDARD effective_entry_date: '2023-12-12' id_number: 543-DEF ach_return_code: null ach_return_reason: null addenda: Oops, forgot to mention noc_code: C04 noc_reason: Bank account name change noc_corrected_data: Aaron Velazquez transfer_trace_id: A1Z2b3y4c5x6DW78 iat: foreign_exchange_indicator: FF foreign_exchange_reference_indicator: '3' foreign_exchange_reference: null iso_destination_country_code: US iso_originating_currency_code: USD iso_destination_currency_code: USD transaction_code: '22' transaction_type_code: MIS foreign_payment_amount: null foreign_trace_number: null originator_street_address: 410 TERRY AVENUE NORTH originator_city_state_province: SEATTLE*WA originator_country_postal_code: US*98109 odfi_name: BANK OF AMERICA NA odfi_identification_number_qualifier: '01' odfi_id: '121000358' odfi_branch_country_code: US rdfi_name: FIFTH THIRD BANK NATIONAL ASSOCIA rdfi_identification_number_qualifier: '01' rdfi_id: 071919133 rdfi_branch_country_code: US counterparty_street_address: 228 S BURNS counterparty_city_state_province: INDEPEDENCE*KS counterparty_country_postal_code: US*67301 payment_related_information_1: NTE*ADD*FCS003348198932 PAYMENT-NUM 351380\\NTE*ADD*601 POP GOODS AND SERVICES payment_related_information_2: null foreign_correspondent_banks: - name: BANK OF AMERICA CANADA id_number_qualifier: '01' id_number: '121000358' branch_country_code: CA initiated_ach_return: value: adjustment_uid: null customer_uid: Trzqy9t6j6tFGoG3 created_at: '2023-07-17T07:07:07.707Z' custodial_account_uids: - Gw4gr1T81YrvLT6M - 66gso857LyQWC6XN description: ACH return debited from 15gTLPAEzHxtSrU6 destination_synthetic_account_uid: rJuYjZuLei2TZji9 id: 40 initial_action_at: '2023-07-17T07:07:07.707Z' net_asset: negative return_uid: 9ZZ87saSFLkkDG7z settled_at: '2023-07-17T09:07:07.707Z' settled_index: 8 source_synthetic_account_uid: 15gTLPAEzHxtSrU6 statement_posted_at: '2019-10-17T00:01:53.682Z' status: settled transaction_batch_uid: '3' transaction_event_uids: - MB2yqBrm3c4bUbou transfer_uid: 1qVSAEjsV55vDZxX type: initiated_ach_return uid: SMwKC1osz77DTEiu us_dollar_amount: '5.21' virtual_reference_number_uid: null ach: ach_return_code: R02 ach_return_reason: Account closed addenda: TXN0055BADD1E cancelled company_discretionary_data: Shhhh company_id: ABC654ZY12 counterparty_name: Marge's Roofing Inc effective_entry_date: '2023-12-12' entry_description: Excellent entry id_number: 543-DEF noc_code: null noc_corrected_data: null noc_reason: null originator_name: Mr. Original originator_routing_number: '123456789' payment_type: S prenote: false sec_code: CCD service_processing: STANDARD transfer_trace_id: A1Z2b3y4c5x6DW78 initiated_wire_return: value: adjustment_uid: null customer_uid: o1gSDeWvEt45Yuaa created_at: '2023-07-17T07:07:07.707Z' custodial_account_uids: - Jz1wjmm1cMyMkqmp description: Wire return debited from pA7zLNS3BtSADfDh destination_synthetic_account_uid: PK3hKtXsfsJ2pfGR id: 41 initial_action_at: '2023-07-17T07:07:07.707Z' net_asset: negative return_uid: 9ZZ87saSFLkkDG7z settled_at: '2023-07-17T09:07:07.707Z' settled_index: 8 source_synthetic_account_uid: pA7zLNS3BtSADfDh statement_posted_at: null status: pending transaction_batch_uid: null transaction_event_uids: [] transfer_uid: null type: initiated_wire_return uid: 67r1gjrkgvYBR6EX us_dollar_amount: '5595.00' virtual_reference_number_uid: null wire: counterparty_name: Ultimate Window Installers, counterparty_bank_address: line1: 101 Common St line2: null line3: Coxsackie NY 12051 US counterparty_bank_name: ACME Bank counterparty_bank_routing_number: '123456789' intermediary_bank_address: line1: 202 Another St line2: Calcium, NY 13616 line3: null intermediary_bank_name: General Bank of Calcium intermediary_bank_routing_number: '987654321' chips: null imad: 20240510NHXPVPQY232293 uetr: null instant_payment_transaction: value: adjustment_uid: null customer_uid: szaxXExVVScwKqPT created_at: '2023-07-17T07:07:07.707Z' custodial_account_uids: - s5DQw78BKi5ye7CX - EffzWWZztHo4B3XM description: Sent RTP ID 20231004043000096P1BAAAA00041250796 to Rupert's Roofers of Raleigh destination_synthetic_account_uid: smfVbCVA4iqHUkUX id: 39 initial_action_at: '2023-07-17T07:07:07.707Z' net_asset: negative return_uid: null settled_at: '2023-07-17T09:07:07.707Z' settled_index: 10 source_synthetic_account_uid: H2uQrLRNAfQr3WLn statement_posted_at: '2019-10-17T00:01:53.682Z' status: settled transaction_batch_uid: '3' transaction_event_uids: - TzqSj2r6NN5MMYu9 transfer_uid: null type: instant_payment uid: 7PpuQuEz9FR8VeQt us_dollar_amount: '13500.45' virtual_reference_number_uid: rdPjBZeKfpGZgaT1 instant_payment: memo: For the 6/5/23 shipment of pineapple popsicles network_transaction_id: 20231004043000096P1BAAAA00041250796 network: fednow failure_code: null failure_reason: null counterparty_name: Marge's Roofing Inc counterparty_bank_name: East West Regional Bank counterparty_bank_routing_number: '123456789' counterparty_account_number_last_four: '3345' payment_id: BayleeStacy original_end_to_end_id: null, initiating_party_name: Rupert's Roofers of Raleigh transmitter_name: Rupert's Roofers of Raleigh counterparty_address: street_number: '456' street1: Oak Ave. street2: null city: Raleigh state: NC postal_code: '27601' country: US counterparty_bank_address: street_number: '789' street1: Bank Blvd. street2: null city: Raleigh state: NC postal_code: '27602' country: US   instant_payment_transmitter: name: Royalty Asset Management street_number: 123 street1: Abc St. city: Boring state: OR postal_code: 97009 wire_transaction: value: adjustment_uid: null customer_uid: Trzqy9t6j6tFGoG3 created_at: '2019-11-15T15:53:13.591Z' custodial_account_uids: - Jz1wjmm1cMyMkqmp - kchtGUEurq3U4Q3b description: Transfer from "Home Savings" to "Ultimate Window Installers Inc." destination_synthetic_account_uid: BUuRwEKGHkNEbDoF id: 32 initial_action_at: '2019-11-15T15:53:13.586Z' net_asset: positive return_uid: null settled_at: '2019-11-17T12:51:12.673Z' settled_index: 8 source_synthetic_account_uid: pA7zLNS3BtSADfDh statement_posted_at: '2019-10-17T00:01:53.682Z' status: settled transaction_batch_uid: '3' transaction_event_uids: - C2xRgpfdyqgbRoJs transfer_uid: LEbStJ7MFSniq18h type: wire uid: 67r1gjrkgvYBR6EX us_dollar_amount: '5595.00' virtual_reference_number_uid: null wire: counterparty_address: line1: 100 Common St line2: null line3: Coxsackie NY 12051 US counterparty_name: Ultimate Window Installers counterparty_bank_address: line1: 101 Common St line2: null line3: Coxsackie NY 12051 US counterparty_bank_name: ACME Bank counterparty_bank_routing_number: '123456789' intermediary_bank_address: line1: 202 Another St line2: Calcium, NY 13616 line3: null intermediary_bank_name: General Bank of Calcium intermediary_bank_routing_number: '987654321' chips: 1234567 imad: null uetr: null bank_to_bank_info: /DAS/REF:55555ZZ000ZZ originator_account_number_last_four: '1234' authorization: authorization_finalized_at: '2019-11-15T20:37:09.904Z' authorization_required_by: '2019-11-16T15:53:13.586Z' authorization_status: client_approved denied_memo: denied memo denied_reason: vrn_archived /transactions/{uid}/authorize: parameters: - $ref: '#/paths/~1auth/parameters/0' - $ref: '#/paths/~1pools~1%7Buid%7D/parameters/1' put: tags: - Transactions summary: Approve or deny a transaction description: Approves or denies a pending Transaction. This endpoint is used to explicitly authorize or reject a Transaction before it is executed. requestBody: required: true content: application/json: schema: properties: authorization_status: type: string description: 'The current status of the transaction authorization. ' enum: - client_approved - client_denied example: client_denied denied_memo: type: string maxLength: 44 description: 'Freeform text (up to 44 characters) that should be attached to the transaction if the transaction is to be denied. Optional. ' denied_reason: type: string description: 'The reason for the authorization denial. For wire transactions, must be one of (`vrn_archived`), (`vrn_locked`), (`international_payment`), (`unauthorized_credit`). For ACH transactions, must be one of (`vrn_archived`), (`vrn_locked`), (`debit_limit_exceeded`), (`unauthorized_credit`), (`unauthorized_debit`), (`insufficient_funds`) ' enum: - debit_limit_exceeded - insufficient_funds - international_payment - unauthorized_credit - unauthorized_debit - vrn_archived - vrn_locked required: - authorization_status responses: '200': description: The authorization resource is returned headers: x-trace-id: $ref: '#/paths/~1auth/post/responses/201/headers/x-trace-id' content: application/json: schema: allOf: - type: object properties: authorization: type: object description: 'Transaction Authorization information. Only present if authorization was required for a given transaction. ' properties: authorization_finalized_at: type: string format: date-time description: 'The date and time when authorization for this transaction got finalized. It will only appear if authorization status is in one of the final statuses: `auto_approved`, `auto_denied`, `client_approved`, `client_denied`, `client_unanswered_auto_approved` or `client_unanswered_auto_denied`. ' example: '2024-10-09T00:12:53.729Z' authorization_required_by: type: string format: date-time description: 'The date and time representing the deadline by which the authorization decision should be made by client. If no authorization is provided by this date, the transaction status will transition to client_unanswered_auto_approved. ' example: '2024-10-10T00:18:53.729Z' authorization_status: type: string enum: - auto_approved - auto_denied - client_approval_pending - client_approved - client_denied - client_unanswered_auto_approved - client_unanswered_auto_denied - created description: 'A value indicating the current state of authorization for this transaction. ' example: client_denied denied_memo: type: string description: 'Freeform text (up to 44 characters) attached as a memo to authorization. It will only appear if authorization status is `auto_denied`, `client_denied` or `client_unanswered_auto_denied`. ' example: denied memo denied_reason: type: string description: 'A description of why the authorization was denied. It will only appear if authorization status is `auto_denied`, `client_denied` or `client_unanswered_auto_denied`. ' example: debit_limit_exceeded '400': description: Bad authorization request headers: x-trace-id: $ref: '#/paths/~1auth/post/responses/201/headers/x-trace-id' content: application/json: schema: $ref: '#/paths/~1returns/get/responses/403/content/application~1json/schema' examples: transaction_authorization_status_error: value: errors: - code: 6009 title: Transaction cannot be authorized detail: Authorization status does not allow updates occurred_at: '2023-10-04T13:23:04.345Z' status: 400 transaction_authorization_decision_window_expired: value: errors: - code: 6010 title: Transaction cannot be authorized detail: Transaction authorization window has passed occurred_at: '2023-10-04T13:23:04.345Z' status: 400 transaction_ineligible_for_authorization: value: errors: - code: 6011 title: Transaction cannot be authorized detail: Transaction is not eligible for authorization occurred_at: '2023-10-04T13:23:04.345Z' status: 400 '403': description: Client authorization disabled. (The Program is not configured for Client Authorization) headers: x-trace-id: $ref: '#/paths/~1auth/post/responses/201/headers/x-trace-id' content: application/json: schema: $ref: '#/paths/~1returns/get/responses/403/content/application~1json/schema' examples: default_routing_error: value: errors: - code: 6012 title: Client authorization is not enabled detail: This program is not configured for client authorization of transactions. status: 403 '422': description: An exception occurred while authorizing transaction headers: x-trace-id: $ref: '#/paths/~1auth/post/responses/201/headers/x-trace-id' content: application/json: schema: $ref: '#/paths/~1returns/get/responses/403/content/application~1json/schema' examples: transaction_authorization_error: value: errors: - code: 6008 title: Transaction cannot be authorized detail: An exception occurred while authorizing transaction occurred_at: '2023-10-04T13:23:04.345Z' status: 422 /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`. ' - 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`. ' - 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`. ' - 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`. ' - 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`. ' - $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%7Buid%7D/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' /transaction_events/{uid}: parameters: - $ref: '#/paths/~1auth/parameters/0' - $ref: '#/paths/~1pools~1%7Buid%7D/parameters/1' get: tags: - Transactions summary: Get a single Transaction Event description: Retrieves a single Transaction Event resource, including its status, timestamps, and associated Transaction details. responses: '200': description: A single Transaction Event 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: settled_index: type: integer description: 'A unique index that indicates the order in which Transaction Events were settled ' example: 9 transaction_uids: type: array description: 'A list of UIDS referring to Transactions this Transaction Event belongs to. ' items: type: string example: - SMwKC1osz77DTEiu - m6FyXmEDgDfng4GZ source_custodial_account_uid: type: string example: dmRtw1xkS9ghrntB description: Custodial Account from which the asset is pulled destination_custodial_account_uid: type: string example: W55zKgvAk3zkpGM3 description: Custodial Account where the asset lands custodial_line_item_uids: type: array description: 'A list of UIDS referring to Custodial Line Items belonging to this event. There are always at least two line items if the status is `settled`. ' items: type: string example: - y4r8oTATb23MdGDF - m9bED9iicUUk8YAc status: type: string enum: - settled description: Transaction Events will always have a status of `settled` us_dollar_amount: type: string example: '12.34' description: The amount will never be negative type: type: string enum: - odfi_ach_deposit - odfi_ach_withdrawal - rdfi_ach_deposit - rdfi_ach_withdrawal example: odfi_ach_deposit debit_card_uid: type: string example: oPeppbFTE9FvYKq5 description: 'If this Transaction Event represents a Debit Card purchase or refund, the UID of the Debit Card used for the purchase/refund. Otherwise not provided. ' net_asset: type: string enum: - positive - negative - neutral example: positive description: 'Indicates whether the Customer''s asset has gone up (`positive`), gone down (`negative`) or stayed the same (`neutral`) as a result of this Transaction Event. This value is determined by `type`. ' description: type: string example: Transfer from Bank ABC 123 to Newline 999 created_at: type: string format: date-time description: 'The date and time when the event is first recognized by Newline. This may be when the Transfer is initiated if the event is associated with one. ' example: '2019-10-15T15:53:13.591Z' settled_at: type: string format: date-time description: The date and time when the event is settled example: '2019-10-16T12:51:12.673Z' examples: transactionEvent: value: 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' /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`. ' - 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%7Buid%7D/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%7Buid%7D/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/~1transaction_events~1%7Buid%7D/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 ' 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. ' 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. ' 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 ' 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. ' 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' /custodial_line_items: parameters: - $ref: '#/paths/~1auth/parameters/0' get: tags: - Transactions summary: List Custodial Line Items description: Retrieves a list of Custodial Line Items. These represent individual debits and credits associated with Custodial Accounts as part of a Transaction Event. parameters: - $ref: '#/paths/~1pools/get/parameters/0' - name: custodial_account_uid in: query schema: type: string example: dmRtw1xkS9ghrntB description: 'Filter by Custodial Account. Multiple values are allowed, e.g. `custodial_account_uid[]=dmRtw1xkS9ghrntB&custodial_account_uid[]=W55zKgvAk3zkpGM3`. ' - name: status in: query schema: type: string enum: - settled - voided description: 'Filter by status. Multiple values are allowed, e.g. `status[]=pending&status[]=settled`. ' - name: us_dollar_amount_max in: query schema: type: number description: 'Return any records having a us_dollar_amount at or below us_dollar_amount_max. ' - name: us_dollar_amount_min in: query schema: type: number description: 'Return any records having a us_dollar_amount at or above us_dollar_amount_min. ' - name: transaction_event_uid in: query schema: type: string example: MB2yqBrm3c4bUbou description: 'Filter by Transaction Event. Multiple values are allowed, e.g. `transaction_event_uid[]=MB2yqBrm3c4bUbou&transaction_event_uid[]=N5tuy12zZzB9bftb`. ' - $ref: '#/paths/~1transaction_events/get/parameters/4' - $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 Custodial 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/~1custodial_line_items~1%7Buid%7D/get/responses/200/content/application~1json/schema' examples: custodialLineItems: value: total_count: 6 count: 2 limit: 2 offset: 0 data: - uid: y4r8oTATb23MdGDF settled_index: 1 transaction_uid: SMwKC1osz77DTEiu transaction_event_uid: MB2yqBrm3c4bUbou custodial_account_uid: Gw4gr1T81YrvLT6M debit_card_uid: null status: settled us_dollar_amount: '5.21' running_us_dollar_balance: '34.21' running_asset_balance: '34.21' asset_quantity: '5.21' asset_type: USD closing_price: '5.00' type: transaction category 8348 description: Deposit from Bank ABC 123 created_at: '2019-10-15T15:53:13.591Z' occurred_at: '2019-10-15T12:09:01Z' settled_at: '2019-10-16T12:51:12.673Z' - uid: m9bED9iicUUk8YAc settled_index: 2 transaction_uid: SMwKC1osz77DTEiu transaction_event_uid: MB2yqBrm3c4bUbou custodial_account_uid: 66gso857LyQWC6XN debit_card_uid: null status: settled us_dollar_amount: '-5.21' running_us_dollar_balance: '92.31' running_asset_balance: '78.90' asset_quantity: '-0.32' asset_type: EUR closing_price: '5.00' type: transaction category 8348 description: Deposit to Newline 999 created_at: '2019-10-15T15:53:13.591Z' occurred_at: '2019-10-15T12:09:01Z' settled_at: '2019-10-16T12:51:12.673Z' - uid: RoT4hmcD1HqyiYs5 settled_index: 3 transaction_uid: MrK36MpkgoJk25uF transaction_event_uid: MB2yqBrm3c4bUbou custodial_account_uid: WfBSdeYee9G1kkJY debit_card_uid: BB2gKYabEpJPoKWw status: settled us_dollar_amount: '-3.50' running_us_dollar_balance: '88.64' running_asset_balance: '88.64' asset_quantity: '-3.50' asset_type: USD closing_price: '3.35' type: Retail Purchase description: Debit to Newline 998 - BOB'S WIDGETS created_at: '2021-10-15T15:53:13.591Z' occurred_at: '2021-10-15T12:09:01Z' settled_at: '2021-10-16T12:51:12.673Z' /custodial_line_items/{uid}: parameters: - $ref: '#/paths/~1auth/parameters/0' - $ref: '#/paths/~1pools~1%7Buid%7D/parameters/1' get: tags: - Transactions summary: Get a single Custodial Line Item description: Retrieves a single Custodial Line Item resource, including the amount, account, and associated Transaction Event. responses: '200': description: A single Custodial 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/~1transaction_events~1%7Buid%7D/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 Custodial Line Items were settled ' example: 9 transaction_uid: type: string example: SMwKC1osz77DTEiu description: UID of the Transaction this Custodial Line Item belongs to transaction_event_uid: type: string example: MB2yqBrm3c4bUbou description: UID of the Transaction Event this Custodial Line Item belongs to custodial_account_uid: type: string example: Jy8degj6iv2QngLo description: UID of the Custodial Account this Custodial Line Item is associated with debit_card_uid: type: string example: 6rVmYmv9VyTawrre description: 'If this Custodial Line Item represents a Debit Card purchase or refund, the UID of the Debit Card used for the purchase/refund. Otherwise not provided. ' status: type: string enum: - settled - voided description: Other statuses such as `pending` will be available later us_dollar_amount: type: string example: '12.34' description: The signed USD amount of this specific Custodial Line Item running_us_dollar_balance: type: - string - 'null' description: 'The running balance after settlement for this specific Asset Type held within the Custodial Account, expressed in US Dollars calculated using the asset price used for settlement. This field may be empty unless the status is `settled` or `voided`. ' example: '34.21' running_asset_balance: type: - string - 'null' description: 'The running balance after settlement for this specific Asset Type held within the Custodial Account, expressed in units of the given asset type. This field may be empty unless the status is `settled` or `voided`. ' example: '1.34' asset_quantity: type: string description: The quantity of the specific asset type for this Custodial Line Item example: '31.21' asset_type: type: string description: The type of asset for this Custodial Line Item example: USD closing_price: type: string description: 'If this Custodial Line Item involves a security purchase/sale the USD value at the time of the purchase/sale ' example: '25.00' type: type: string description: 'Symbols and/or numbers that represent different types of Custodial Line Items. ' example: transaction category 8348 description: type: string description: 'Descriptions pulled from the custodians, such as through NACHA description or ISO-8583 data element 43 ' example: deposit from external account created_at: type: string format: date-time description: 'The date and time when the Custodial Line Items is first recognized by Newline. This may be when the Transfer is initiated if the Custodial Line Item is associated with one. ' example: '2019-10-18T15:53:13.591Z' occurred_at: type: string format: date-time description: This field may be empty if status is not `settled` or `voided` example: '2019-10-15T12:09:01Z' settled_at: type: string format: date-time description: The date and time when the Custodial Line Item is settled example: '2019-10-17T11:09:01Z' examples: custodialLineItem: value: uid: y4r8oTATb23MdGDF settled_index: 1 transaction_uid: SMwKC1osz77DTEiu transaction_event_uid: MB2yqBrm3c4bUbou custodial_account_uid: Gw4gr1T81YrvLT6M debit_card_uid: null status: settled us_dollar_amount: '5.21' running_us_dollar_balance: '34.21' running_asset_balance: '34.21' asset_quantity: '5.21' asset_type: USD closing_price: '5.00' type: transaction category 8348 description: Deposit from Bank ABC 123 created_at: '2019-10-15T15:53:13.591Z' occurred_at: '2019-10-15T12:09:01Z' settled_at: '2019-10-16T12:51:12.673Z' components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: Access token signed with shared HMAC x-explorer-enabled: false