{"openapi":"3.0.2","info":{"title":"Newline Platform API","version":"0.1.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&nbsp;](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 &amp; 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<img src=\"https://files.readme.io/955347d-image.png\">\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_payments_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<img src=\"https://files.readme.io/fd1743f-Postman_Dowload_snip.jpg\">\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.<br><br><br>**Note**<br>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.  <br>  <br>Transmitters are only required for the `wire` and `instant_payment` types (see the `wire_transmitter` and `instant_payment_transmitter` objects in the [Initiate a Transfer](https://developers.newline53.com/reference/post_transfers) reference). Client's should also take note of the `initiator_type` field, which dictates from where Transmitter information is pulled. For more context on Transmitters, refer to the [Payment Rail Regulation](https://newline-enterprise-group.readme.io/docs/transfer#payment-rail-regulation) section below. |\n| Partner | Any infrastructure partner integrated within the Newline Platform. |\n| Program | The Program is custom tailored to your offering and purpose built to enable financial products on your application. The Program defines what Synthetic and Custodial Account types, Customer Types, and Transactions Types are available for your Customers to utilize. The Program configuration is defined between the Client and Newline based on your (i.e., the Client's) use case. |\n| Product | Products represents the financial products available to your Customers. The Product object contains the account, compliance, and customer profile responses necessary for your Customers to gain access. |\n| Customer Product | The Customer Product is created when the Customer is added to a Product and respective Program. This often includes Newline automatically creating any needed financial products for the Customers' use. For instance, a Synthetic Account to represent the origination account at Fifth Third. |\n| Service Offering | The financial product offered by the Newline platform. These can be (but are not limited to) checking, savings, brokerage, or retirement accounts. |\n| Pool | Container for one or more Synthetic Accounts, with Assets owned by one or more Customers. Pools allow for shared assets and flexibility in ownership and transfer of assets. |\n| Custodial Accounts | This resource within Newline represents the assets held by your Customers, with direct alignment to accounts opened at Fifth Third. Custodial Accounts have the following relationships: one-to-one with Customers, and one-to-Many with Synthetic Accounts. |\n| Synthetic Accounts | How Newline represents the assets held by your Customers. These are the accounts that Customers view and interact with on your application. Synthetic Accounts are also used to manage external accounts (i.e., Counterparties) that your Customers will likely use within your application. |\n| Virtual Reference Number (VRN) | Virtual Reference Numbers (or VRNs) are virtualized account numbers. They are aliases to a Synthetic Account, and can form a many-to-one relationship with their parent Synthetic Account. |\n| Transfer | The movement of assets from one Synthetic Account to another Synthetic Account. Most of asset movement initiated by your application will result in a Transfer. A successful Transfer will result in at least one Transaction. |\n| Transaction | Transactions are created based on how you instruct Newline to move assets (a Transfer) or how assets are moved or spent outside of your application (For example, ACH, Wire, and Instant Payments Transfers). The Transaction contains the amount, origin, and destination of assets. Newline categorizes Transactions into types to assist in their classification and representation. |\n| Transaction Events | The steps taken to complete the Transaction. These can be used to view the progress of an in-flight Transaction or see the history of a completed Transaction. |"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Access token signed with shared HMAC"}}},"x-explorer-enabled":false,"servers":[{"url":"https://sandbox.newline53.com/api/v1"}],"tags":[{"name":"Auth","description":"The Authentication section explains how to securely interact with Newline's API using access tokens and static IP addresses. Learn how to generate and refresh tokens to access protected resources.  \n\n**Endpoints:**\n\n- POST [Generate an authentication token: POST /auth](https://developers.newline53.com/reference/post_auth)\n\nNewline requires access tokens and static IP addresses for authentication and authorization when requesting any resource endpoints. [POST /auth](https://developers.newline53.com/reference/post_auth) is used to obtain and refresh the required access tokens. Please work with your Relationship Team or the Newline Team in all environments to set up the IP Allowlist for your Program.  \nTo obtain an access token, you must submit a refresh token. After a program is set up, Newline will share your Program UID and HMAC key offline. These values are required for the refresh token and access token requests.\n\n## Auth Flow\n\nThe authentication flow is as follows:\n\n1. Create a JWT using the following claim:\n```\n{\n  \"iat\": <current Epoch time>,\n  \"sub\": <Program UID>\n}\n ```\n\n1. Sign the JWT to create a JWS with the shared key using HS512 / SHA-512.\n\n2. Exchange for an access token by sending a request to [POST /auth](https://developers.newline53.com/reference/post_auth), using the JWS in the `Authorization` header.\n\n3. Access resources through other endpoints using the returned token in the `Authorization` header for up to 8 hours.\n\n4. Repeat the process as needed to continue authenticating successfully.\n\n> **Note** \n> If a new access token is requested within the 8 hours of a previous token being successfully exchanged, the new token will still be generated. This does not expire the last token, and both tokens are usable simultaneously until their respective time is up. However, it is encouraged to use the new token and discard the old one if possible, as this behavior may change in the future."},{"name":"Customers","description":"The Customers section provides details on managing end-user accounts. Learn how to create, update, and archive customer records and onboard them to financial products while meeting KYC/AML requirements.\n\n**Endpoints:**\n\n- GET [List Customers: GET /customers](https://developers.newline53.com/reference/get_customers)\n    \n- POST [Create a new Customer: POST /customers](https://developers.newline53.com/reference/post_customers)\n    \n- GET [Get a single Customer: GET /customers/{uid}](https://developers.newline53.com/reference/get_customers-uid)\n    \n- PUT [Adjust Customer Data: PUT /customers/{uid}](https://developers.newline53.com/reference/put_customers-uid)\n    \n- DELETE [Archive a Customer: DELETE /customers/{uid}](https://developers.newline53.com/reference/delete_customers-uid)\n    \nA Customer on the Newline Platform is the end user of your application. Customers are unique to each Program, and managing all accounts and identifying information is handled on a Program-by-Program basis.  \nThe ability to create new Customers is also a preset condition of your Program at Newline. Please see the below sections for more details.\n\n## Newline preset-Customers\n\nIn cases where the Client also serves as the Customer (i.e., the Client is both the end-user and the managing entity over any financial products), Newline will create Customers upon Program onboarding. Clients will also be precluded from creating new Customers.\n\n## Client-initiated Customers\n\n**Customer Onboarding Process for Clients**  \nWhen managing customer onboarding, follow the outlined steps and key considerations below.\n\n### Steps for Onboarding Customers:\n\n1. Initial Submission:\n\n    1. Submit the external_uid and email using the Customers Endpoint.\n\n2. Provide Personally Identifiable Information (PII):\n\n    1. After the initial submission, supply the remaining PII for the customer.\n\n    2. Ensure that all required PII fields are complete. Requests with complete or missing fields will be accepted.\n\n3. Edit PII (Optional):\n\n    1. PII can be updated until a valid request is sent to onboard the customer to a product using the Customer Product Endpoint.\n\n4. Submit Profile Responses:\n\n    1. Provide profile responses to meet the product's profile requirements.\n\n    2. Profile Requirements can include data such as:\n\n        1. Risk tolerance\n\n        2. Income level\n\n        3. Other product-specific information\n\n5. Verify Profile Requirements:\n\n    1. Use the Product Endpoint to access the Profile Requirements and ensure the customer satisfies all prerequisites for onboarding.\n\n6. Initiate Onboarding Request:\n\n    1. Submit a valid onboarding request for the customer using the Customer Products Endpoint.\n\n## Additional Considerations:\n\nKYC/AML Verification:\n\n- To join a program, customers must pass Know Your Customer (KYC) and Anti-Money Laundering (AML) identity verification as required by Fifth Third Bank.\n\n- KYC_status on the customer record will indicate the current state of the KYC/AML workflow.\n\nOnce a valid onboarding request is received, Newline initiates KYC/AML verification using the customer's PII.  \n**Verification statuses include:**\n\n- Approved\n\n- Manual Review\n\n- Documents Required\n\n- Denied\n\nNewline will work with clients to define these states.\n\n## Program-Specific Records:\n\n- A new customer record must be created for each program, even if an identical customer exists in another program.\n\n- Customer records are not accessible outside of their associated program.\n\n## Customer Management Functions:\n\nThe Customers Endpoint can also be used to perform management actions such as:\n\n- Freezing or unfreezing a customer\n\n- Archiving a customer"},{"name":"Pools","description":"Pools group multiple Customers for asset sharing and distributed account ownership. Each Pool is unique to a Customer or program.\n\n**Endpoints:**\n\n- GET [List Pools: GET /pools](https://developers.newline53.com/reference/get_pools)\n    \n- GET [Get a single Pool: GET /pools/{uid}](https://developers.newline53.com/reference/get_pools-uid)\n\nA pool is a construct that Newline uses to associate multiple customers with each other. A Pool is always associated with at least one Customer, but all accounts are only ever associated with a single Pool. This enables asset sharing and distributed ownership of accounts across multiple Customers.\n\nNewline currently supports single Customer Pools, where **one Customer is associated with one Pool and vice versa**. All accounts, transfers, and transactions are related to the Customer's Pool, not the Customer. The Pool UID appears on several endpoint responses and may be required by the API in some instances."},{"name":"Products","description":"Products represent financial services available in your program. Discover onboarding requirements, prerequisites, and detailed product configurations.\n\n**Endpoints:**\n\n- GET [List Products: GET /products](https://developers.newline53.com/reference/get_products)\n    \n- GET [Get a single Product: GET /products/{uid}](https://developers.newline53.com/reference/get_products-uid)\n\nThe Products endpoint represents the financial products available to your Customers. It exposes the accounts, compliance, and Customer Profile Requirements necessary for your Customer to access the Product. For some programs, a customer must onboard one product before another product is made available. Newline will work with clients to define the required Product onboarding sequence as part of your Program.\n\nUse the Products endpoint to view the Products available to your Program and the prerequisite information or actions that must be taken for a Customer to access the Product.\n\nFor more information about Newline's products and their utilization, please refer to the [Products Programs](https://developers.newline53.com/docs/product-programs) guides."},{"name":"Customer Products","description":"Customer Products link Customers to financial products. This section outlines how to onboard customers, manage their product relationships, and track statuses.\n\n**Endpoints:**\n\n- GET [List Customer Products: GET /customer_products](https://developers.newline53.com/reference/get_customer-products)\n    \n- POST [Onboard a Customer onto a Product: POST /customer_products](https://developers.newline53.com/reference/post_customer-products)\n    \n- GET [Get a single Customer Product: GET /customer_products/{uid}](https://developers.newline53.com/reference/get_customer-products-uid)\n\nCustomer Product records are generated when a Customer is submitted for onboarding to a specific Product.\n\n## Newline preset-Customers\n\nIf the Client is also the Customer, the Customer Product record will be autogenerated during the Client's onboarding to our production environment.\n\n## Client-initiated Customers\n\nWhen clients onboard a Customer, the Customer must fulfill the prerequisite Product requirements. Newline will then verify that the Product requirements have been met.\n\nIf the Product requirements are met, Newline will proceed with account opening and feature enablement as specified by the Product. If the product requirements are unmet, Newline will return an error response indicating which element of the product validation failed."},{"name":"Custodial Accounts","description":"Fifth Third Bank holds Custodial Accounts and represents funds managed for Customers. Through these endpoints, you can manage balances and track account statuses.\n\n**Endpoints:**\n\n- GET [List Custodial Accounts: GET /custodial_accounts](https://developers.newline53.com/reference/get_custodial-accounts)\n    \n- GET [Get a single Custodial Account: GET /custodial_accounts/{uid}](https://developers.newline53.com/reference/get_custodial-accounts-uid)\n\nA Custodial Account is the account held by Fifth Third Bank. Custodial Accounts in a Program can only be created for the Service Offerings that have been configured for that Program.\n\nA Customer must successfully complete onboarding and pass all KYC/AML checks before their Custodial Accounts can be opened. This endpoint can be used to retrieve the accounts (active and archived) and their balances for your Customers. All funds must be emptied from a Custodial Account before it can be archived."},{"name":"Synthetic Accounts","description":"Synthetic Accounts serve as the foundation for asset tracking in Newline. They allow for flexible configurations tailored to your program.\n\n**Endpoints:**\n\n- GET [List Synthetic Account Types: GET /synthetic_account_types](https://developers.newline53.com/reference/get_synthetic-account-types)\n\n- GET [Get a single Synthetic Account Type: GET /synthetic_account_types/{uid}](https://developers.newline53.com/reference/get_synthetic-account-types-uid)\n\n- GET [List Synthetic Accounts: GET /synthetic_accounts](https://developers.newline53.com/reference/get_synthetic-accounts)\n\n- POST [Create a New Synthetic Account: POST /synthetic_accounts](https://developers.newline53.com/reference/post_synthetic-accounts)\n\n- GET [Get a single Synthetic Account: GET /synthetic_accounts/{uid}](https://developers.newline53.com/reference/get_synthetic-accounts-uid)\n\n- PUT [Update Synthetic Account metadata: PUT /synthetic_accounts/{uid}](https://developers.newline53.com/reference/put_synthetic-accounts-uid)\n\n- DELETE [Archive a Synthetic Account: DELETE /synthetic_accounts/{uid}](https://developers.newline53.com/reference/delete_synthetic-accounts-uid)\n\nSynthetic Accounts are the foundation of your application and the interface between your Customers. They are designed to track any asset type for any Customer at Newline. A single Synthetic Account can be configured to blend assets from multiple core accounts for multiple Customers.\n\nThe types and distribution of assets, the number of Customers, and many other rules governing a Synthetic Account's usage can be configured for each Account on a Program-by-Program basis via the Synthetic Account Types.\n\nThe list of Synthetic Account Types and their rules for each Program are set up during Program configuration. Each Synthetic Account Type belongs to one of a handful of Synthetic Account Categories that govern their primary purpose and handling by the Newline platform, such as general use or external accounts. You may retrieve the complete list of available types via the [GET /synthetic_account_types](https://developers.newline53.com/reference/get_synthetic-account-types) endpoint."},{"name":"Transfers","description":"Transfers facilitate the movement of assets between accounts, enabling transactions such as payments and withdrawals.\n\n**Endpoints:**\n\n- GET [List Transfers: GET /transfers](https://developers.newline53.com/reference/get_transfers)\n\n- POST [Initiate a Transfer: POST /transfers](https://developers.newline53.com/reference/post_transfers)\n\n- GET [Get a single Transfer: GET /transfers/{uid}](https://developers.newline53.com/reference/get_transfers-uid)\n\n- PUT [Cancel a Transfer: PUT /transfers/{uid}/cancel](https://developers.newline53.com/reference/put_transfers-uid-cancel)\n\nA Transfer is the Action of moving assets between two Synthetic Accounts. Most asset movement initiated by your application will result in a Transfer. Asset movement is determined by the makeup of assets in both participating accounts, the Synthetic Account Type of the participating accounts, the available Custodial Accounts for all participating Customers, and the overall Program configuration. A Transfer can never be initiated between two external accounts.\n\n### Company ID Behavior\n\nThe company_id field is optional when initiating a transfer. However, it becomes required if your organization has multiple company IDs or multiple custodial accounts, to ensure accurate routing of funds. If provided, the value will be validated.\n\nIn sandbox environments:\n\n- `company_id` is optional and will be validated if supplied.\n- `company_id` and custodial accounts are always in a 1:1 relationship.\n\n> **Note** \n> Any time a Transfer is created, it creates 1+ Transactions, which are returned in the response payload for a successful Transfer. Please note or record these uids, as they will be needed to query the Transaction object and any associated key data points. For instance, Fed IMAD or CHIPS SSN is used for outgoing wires."},{"name":"Transactions","description":"Transactions represent asset movements, such as ACH payments, wire transfers, or card purchases. Track transaction statuses and events through these endpoints.  \n**Endpoints:**\n\n- GET [List Transactions: GET /transactions](https://developers.newline53.com/reference/get_transactions)\n\n- GET [Get a single Transaction: GET /transactions/{uid}](https://developers.newline53.com/reference/get_transactions-uid)\n\n- PUT [Approve or deny a Transaction: PUT /transactions/{uid}/authorize](https://developers.newline53.com/reference/put_transactions-uid-authorize)\n\n- GET [List Transaction Events: GET /transaction_events](https://developers.newline53.com/reference/get_transaction-events)\n\n- GET [Get a single Transaction Event: GET /transaction_events/{uid}](https://developers.newline53.com/reference/get_transaction-events-uid)\n\n- GET [List Synthetic Line Items: GET /synthetic_line_items](https://developers.newline53.com/reference/get_synthetic-line-items)\n\n- GET [Get a single Synthetic Line Item: GET /synthetic_line_items/{uid}](https://developers.newline53.com/reference/get_synthetic-line-items-uid)\n\n- GET [List Custodial Line Items: GET /custodial_line_items](https://developers.newline53.com/reference/get_custodial-line-items)\n\n- GET [Get a single Custodial Line Item: GET /custodial_line_items/{uid}](https://developers.newline53.com/reference/get_custodial-line-items-uid)\n\nTransactions are created based on how you instruct Newline to move assets (a Transfer) or how assets are moved or spent outside your application (ATM withdrawals, debit card purchases, wire transfers, etc…). The Transaction contains the amount, origin, and destination of assets. Newline categorizes Transactions into types to assist in their classification and representation.\n\nTransactions fall into many categories, including debit card purchases, direct deposits, interest, and fees. This endpoint can retrieve a list of Transactions or track the status of an ongoing Transaction.\n\nTransaction Events are created as a result of a Transaction. They capture the steps required to complete the Transaction. These can be used to view the progress of an in-flight Transaction or see the history of a completed Transaction.\n\nLine Items are created for each Transaction Event. They catalog the individual credits and debits associated with the accounts involved in the Transaction."},{"name":"Virtual Reference Numbers","description":"VRNs act as aliases for accounts, enabling unique use cases like accounts receivable segmentation or reconciliation.  \n\n**Endpoints:**\n\n- GET [List Virtual Reference Numbers: GET /virtual_reference_numbers](https://developers.newline53.com/reference/get_virtual-reference-numbers)\n\n- POST [Create a new Virtual Reference Number: POST /virtual_reference_numbers](https://developers.newline53.com/reference/post_virtual-reference-numbers)\n\n- GET [Get a single Virtual Reference Number: GET /virtual_reference_numbers/{uid}](https://developers.newline53.com/reference/get_virtual-reference-numbers-uid)\n\n- PUT [Edit a Virtual Reference Number: PUT /virtual_reference_numbers/{uid}](https://developers.newline53.com/reference/put_virtual-reference-numbers-uid)\n\n- DELETE [Archive a Virtual Reference Number: DELETE /virtual_reference_numbers/{uid}](https://developers.newline53.com/reference/delete_virtual-reference-numbers-uid)\n\n- PUT [Lock a Virtual Reference Number: PUT /virtual_reference_numbers/{uid}/lock](https://developers.newline53.com/reference/put_virtual-reference-numbers-uid-lock)\n\n- PUT [Unlock a Virtual Reference Number: PUT /virtual_reference_numbers/{uid}/unlock](https://developers.newline53.com/reference/put_virtual-reference-numbers-uid-unlock)\n\nVirtual Reference Numbers (or VRNs) are virtualized account numbers that point to a single deposit account. They are aliases to a Synthetic Account and can form a many-to-one relationship with their parent Synthetic Account.\n\n**Common VRNs Use Cases:**\n\n- This is to reference a stored funds product that is client-managed on a separate ledger. Clients can then provide VRNs to external merchants or counterparties who wish to pay for that stored fund's product.\n\n- This provides Clients with another layer of network-addressable account numbers with which to accept payments. This many-to-one relationship affords Clients account segmentation. For instance, one VRN is utilized for Accounts Receivable (AR) while the other is used for Accounts Payable (AP), all while referencing the same underlying Account.\n\nThese same VRNs can then be aligned with Custodial Accounts transactions to allow for quick reconciliation or accounting.\n\n> **Note**\n> For certain payment rails, like Instant Payments, VRNs must be registered with Newline and Fifth Third before being used, as this will allow for network acceptance. Please review the fields in each API reference to confirm Instant Payment registration."},{"name":"Returns","description":"The Returns endpoints help initiate, track, and manage returns of received and originated payments. These endpoints are accessible within the Sandbox and Production environments.\n\n**Endpoints:**\n\n- GET [List Returns: GET /returns](https://developers.newline53.com/reference/get_returns)\n- POST [Create a new Return: POST /returns](https://developers.newline53.com/reference/post_returns)\n- GET [Get a single Return: GET /returns/{uid}](https://developers.newline53.com/reference/get_returns-uid)\n\nThe returns endpoint allows for the retrieval and creation of return transactions within the system.\n\n[GET List Returns](https://newline-enterprise-group.readme.io/reference/get_returns)- Use this endpoint to retrieve a list of all return transactions. You can filter the results based on various parameters such as status or date.\n\n[POST Create a New Return](https://newline-enterprise-group.readme.io/reference/post_returns)- This endpoint is used to Create a new return transaction. Return can only be created for eligible transactions that have already been completed.\n\n[GET a Single Return](https://newline-enterprise-group.readme.io/reference/get_returns-uid)- Use this endpoint to retrieve details about a specific return transaction."},{"name":"Combined Transfers","description":"The Combined Transfers endpoint allows clients to create both a transfer and a counterparty in a single API call. This simplifies the process by eliminating the need to first create an external synthetic account and then reference it when initiating a transfer.\n\n## Endpoints:\n\n- GET List Combined Transfers: [GET /combined_transfers](https://developers.newline53.com/reference/get_combined-transfers)\n- POST Create a Combined Transfer: [POST/combined_transfers](https://developers.newline53.com/reference/post_combined-transfers)\n- GET Get a Single Combined Transfer: [GET /combined_transfers/{uid}](https://developers.newline53.com/reference/get_combined-transfers-uid)\n\nTransfers facilitate the movement of assets between accounts, enabling transactions such as payments and withdrawals. Combined Transfers work by creating both a synthetic account and a transfer in one API call, streamlining the process and reducing the steps required for asset movement.\n\nThe types and distribution of assets, the number of customers, and other rules governing the usage of Combined Transfers can be configured for each account on a program-by-program basis. This includes setting up the synthetic account types and defining the rules for asset movement between accounts.\n\n## Combined Transfers Statuses:\n\n**Queued:** The combined transfer request has been received and is waiting to be processed.  \n**Pending:** The combined transfer is currently being processed.  \n**Failed:** The combined transfer could not be completed due to an error.  \n**Completed:** The combined transfer has been successfully completed."},{"name":"Sandbox","description":"The Sandbox section provides tools to test and simulate interactions with the Newline API in a controlled environment.\n\n**Endpoints:**\n\n- POST [Simulate a Transaction: POST /sandbox/mock_transactions](https://developers.newline53.com/reference/post_sandbox-mock-transactions)"}],"paths":{"/auth":{"parameters":[{"in":"header","name":"x-trace-id","description":"A unique identifier provided for each request. Duplicate values submitted in requests within 7 days of each other will cause the request to be rejected.\n","schema":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"required":true}],"post":{"tags":["Auth"],"summary":"Generate an authentication token","description":"An access token can be generated by providing a refresh token. The generated token then can be used as an authentication token to access resources for up to 8 hours.\n\nThe Client will need to provide a JWS, its payload containing Program UID as `sub` (subject) and current Epoch time as `iat` (issued at timestamp), signed by an HMAC that has been shared offline previously using HS512. See the above guide for more details.\n\nWhen Newline processes the `POST /auth` request, it validates that the `iat` claim is current. A 30-second difference is allowed to account for clock skew. Nevertheless, it is important that the refresh token be submitted as quickly as possible after it is generated to avoid failure in receiving an access token. Note that the returned access token is a valid JWS following `auth-` and the whole value (`auth-header.payload.signature`) must be provided in the `Authorization` header when making requests to other endpoints.","parameters":[{"in":"header","name":"Authorization","description":"Refresh token signed with shared HMAC","schema":{"type":"string"},"example":"header.payload.hmacsignature","required":true}],"responses":{"201":{"description":"A new authentication token is generated","headers":{"x-trace-id":{"description":"The unique identifier provided with the request.","schema":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Access token that can be used in the `Authorization` header when sending requests to other endpoints for up to 8 hours.\n","example":"auth-header.payload.signature"}}}}}}}}},"/customers":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Customers"],"summary":"Get a list of Customers","description":"Retrieves a list of Customers filtered by the given parameters. Filter parameters are not case sensitive, but will only return exact matches.\n\nMultiple filter parameters can be provided at once, but a result will not be returned unless there are exact matches for all submitted parameters. As an example: submitting `first_name=Olive&last_name=Oyl` would match exactly \"Olive Oyl\" but NOT \"Olive Boyl\" or \"Oliver Oyl\".\n\nThe list endpoint will not include sensitive Customer data such as address or DOB. This can only be retrieved by viewing a specific Customer record. By default we do not display Customers in the `initiated` status, as Customers in this status have not completed onboarding. To cause Customers with this status to be included in the list you must provide the `include_initiated=true` parameter.","parameters":[{"name":"uid","in":"query","schema":{"type":"string","example":"uKxmLxUEiSj5h4M3"},"description":"Filter by Customer. Multiple values are allowed e.g. `uid[]=uKxmLxUEiSj5h4M3&uid[]=y9reyPMNEWuuYSC1`.\n"},{"name":"status","in":"query","schema":{"type":"string","enum":["initiated","queued","identity_verified","active","manual_review","rejected","pending_archival","archived","under_review"]},"description":"Filter by onboarding status. Please note that the `initiated` enum value will not be respected unless the `include_initiated=true` parameter is also provided. Multiple values are allowed e.g. `status[]=queued&status[]=active`.\n"},{"name":"include_initiated","in":"query","schema":{"type":"boolean","example":true},"description":"By default, Customers in `initiated` status are not shown, even if the `status=initiated` parameter is provided. In order for Customers with status `initiated` to appear in search results, parameters must include `include_initiated=true`\n"},{"name":"kyc_status","in":"query","schema":{"type":"string","enum":["approved","denied","documents_provided","documents_rejected","manual_review","pending_id_documents","pending_poa_documents","pending_idandpoa_documents","retake_images","pre_verified"]},"description":"Filter by KYC status. Multiple values are allowed e.g. `kyc_status[]=approved&kyc_status[]=under_review`."},{"name":"customer_type","in":"query","schema":{"type":"string","example":"primary","enum":["primary","secondary","sole_proprietor"]},"description":"Only return Customers with a customer type matching exactly what is submitted. Multiple values are allowed e.g. `customer_type[]=primary&customer_type[]=secondary`.\n"},{"name":"first_name","in":"query","schema":{"type":"string","example":"Olive"},"description":"Only return Customers with a first name matching exactly what is submitted. Multiple values are allowed e.g. `first_name[]=Olive&first_name[]=Jack`.\n"},{"name":"last_name","in":"query","schema":{"type":"string","example":"Oyl"},"description":"Only return Customers with a last name matching exactly what is submitted. Multiple values are allowed e.g. `last_name[]=Oyl&last_name[]=Hammon`.\n"},{"name":"email","in":"query","schema":{"type":"string","example":"olive.oyl@popeyes.com"},"description":"Only return Customers with an email address matching exactly what is submitted. Multiple values are allowed e.g. `email[]=olive.oyl@popeyes.com&email[]=olive.oyl2@gmail.com`.\n"},{"name":"locked","in":"query","schema":{"type":"boolean","example":false},"description":"Only return locked Customers if `true` and only return unlocked Customers if `false`"},{"name":"program_uid","in":"query","schema":{"type":"string","example":"pQtTCSXz57fuefzp"},"description":"Only return Customers belonging to the submitted Program. Multiple values are allowed e.g. `program_uid[]=pQtTCSXz57fuefzp&program_uid[]=oPsSBRWy46etdeyo`.\n"},{"name":"business_name","in":"query","schema":{"type":"string","example":"Business inc"},"description":"Only return Customers with a business name at least partially matching what is submitted. Exact matches will be sorted first.\n"},{"$ref":"#/paths/~1transfers/get/parameters/1"},{"$ref":"#/paths/~1transfers/get/parameters/2"},{"$ref":"#/paths/~1pools/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/2"},{"name":"sort","in":"query","schema":{"type":"string","enum":["activated_at_asc","activated_at_desc","first_name_asc","first_name_desc","last_name_asc","last_name_desc","email_asc","email_desc"]}}],"responses":{"200":{"description":"A list of Customers 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/~1transfers/post/requestBody/content/application~1json/schema/allOf/0"},{"$ref":"#/paths/~1customers/post/responses/201/content/application~1json/schema/allOf/1"},{"type":"object","properties":{"details":{"$ref":"#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1/properties/details/allOf/0"}}}]}}}}]},"examples":{"customer_list":{"value":{"total_count":10,"count":2,"limit":2,"offset":0,"data":[{"activated_at":"2019-10-14T03:21:53.301Z","created_at":"2019-10-13T03:21:53.301Z","customer_type":"primary","details":{"first_name":"Cletus","middle_name":"Nathanial","last_name":"Borer","suffix":null,"phone":"4863567322"},"email":"Cletus_Borer@hotmail.com","external_uid":"0396a8f6-37d5-4386-bb63-86987ac88132","client_verified":false,"kyc_status":"pending_id_documents","lock_reason":null,"locked_at":null,"pool_uids":["1rNd8vRVa4GX84vi"],"primary_customer_uid":null,"program_uid":"Sw9DjTGJq5L1ctZN","secondary_customer_uids":[],"status":"manual_review","total_balance":"0","uid":"uKxmLxUEiSj5h4M3","archived_at":null},{"activated_at":"2021-10-13T03:22:53.301Z","created_at":"2021-10-12T03:22:53.103Z","customer_type":"sole_proprietor","details":{"first_name":"Billy","middle_name":"Bob","last_name":"Beansmith","business_name":"Billy Bob's Beans","suffix":null,"phone":"4863567323"},"email":"billybob@beansmith.name","external_uid":"0396a8f7-37d5-4386-bb63-86987ac8813c","client_verified":false,"kyc_status":"approved","lock_reason":null,"locked_at":null,"pool_uids":["2rNd8vRVa4GX84vh"],"primary_customer_uid":null,"program_uid":"Tw9DjTGJq5L1ctZ1","secondary_customer_uids":["6gSxo29K4Q3CLseL","Hu1B6KMNR8juYwb5"],"status":"active","total_balance":"10","uid":"3KxmLxUEiSj5h4Mu","archived_at":null},{"activated_at":"2019-10-16T03:21:53.301Z","created_at":"2019-10-14T03:21:53.301Z","customer_type":"primary","details":{"first_name":"Lemuel","middle_name":"Brian","last_name":"Olson","suffix":"Jr.","phone":"6728868534"},"email":"Lemuel95@hotmail.com","external_uid":"844b9579-3a5d-47f0-88b2-305548974479","client_verified":false,"kyc_status":"approved","lock_reason":"Customer Reported Fraud","locked_at":"2020-03-30T15:15:06Z","pool_uids":["o5oZEkpMte8zGJmR","96E5UzZyTXyJmFpm"],"primary_customer_uid":null,"program_uid":"Sw9DjTGJq5L1ctZN","secondary_customer_uids":[],"status":"active","total_balance":"-606.4","uid":"y9reyPMNEWuuYSC1","archived_at":null}]}}}}}}}},"post":{"tags":["Customers"],"summary":"Create a new Customer","description":"This endpoint is used to initialize a new Customer. All request body data is optional unless otherwise specified. For customer types other than `primary`, `customer_type` must be specified.\n\nThe `customer_type` cannot be changed after the customer is created. Customer details accepted by [Adjust Customer Data](https://developers.newline53.com/reference/put_customers-uid) can be sent in this request if desired. See Adjust Customer Data for an example with all customer details provided.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"customer_type":{"type":"string","enum":["primary","secondary","sole_proprietor"],"description":"The type of Customer. Defaults to `primary`.\n"},"primary_customer_uid":{"type":"string","nullable":true,"description":"The UID of the Primary Customer with whom this Secondary Customer will be affiliated. Required for and only applicable to requests with customer_type `secondary`. Cannot be updated later from the initial value.\n"},"client_verified":{"type":"boolean","nullable":true,"description":"Indicates whether the client has already performed identity verification of the Customer. The client's Program must be configured to accept this value. All Customers in a Program configured for this value must submit true in this field to complete onboarding. This value defaults to `false`.\n"}}},{"$ref":"#/paths/~1customers~1%7Buid%7D/put/requestBody/content/application~1json/schema"}]},"examples":{"primary":{"summary":"create primary","value":{"external_uid":"client-generated-42","email":"tomas@example.com"}},"secondary":{"summary":"create secondary","value":{"external_uid":"client-generated-42","email":"tomas@example.com","customer_type":"secondary","primary_customer_uid":"dc6PApa2nn9K3jwL"}},"primary-empty":{"summary":"create primary (empty body)","value":{}}}}}},"responses":{"201":{"description":"A newly created Customer is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/0"},{"type":"object","properties":{"activated_at":{"type":"string","format":"date-time","readOnly":true,"example":"2019-10-15T03:21:53.301","description":"The date and time at which this Customer was activated."},"created_at":{"type":"string","format":"date-time","readOnly":true,"example":"2019-10-14T03:21:53.301"},"customer_type":{"type":"string","enum":["primary","secondary","sole_proprietor","sub_ledger"],"description":"The type of Customer\n","example":"primary"},"email":{"type":"string","description":"Email of the Customer","example":"olive.oyl@newline53.com"},"client_verified":{"type":"boolean","description":"Indicates whether or not the client is responsible for identity verification of this Customer. If true, the `kyc_status` will be \"pre_verified\".","example":false},"kyc_status":{"type":"string","description":"A value indicating the state of KYC/AML evaluation.\n","enum":["manual_review","approved","denied","pending_id_documents","pending_poa_documents","pending_idandpoa_documents","documents_provided","documents_rejected","retake_images","pre_verified"],"readOnly":true,"nullable":true},"kyc_status_reasons":{"type":"array","description":"A list of reasons for the current `kyc_status`.","items":{"type":"string","enum":["Approved","Valid Documents Provided","Archived due to application inactivity","Further review required","Minor (age < 18 years)","Invalid Documents submitted multiple times","Minimum requirements to open an account were not met","Invalid documents","Incorrect document provided for ID document","Expired ID","Illegible ID document","Incorrect document provided for POA document","Invalid POA provided","Illegible POA document"]},"readOnly":true,"nullable":true},"lock_reason":{"type":"string","nullable":true,"readOnly":true,"example":null,"description":"The lock reason provided by the Client, an admin User, or the system at the time the Customer was locked. This field will be null if and only if the `locked_at` is null.\n"},"locked_at":{"type":"string","format":"date-time","nullable":true,"readOnly":true,"example":null,"description":"The date and time when the Customer was locked. This field will be null if and only if the `lock_reason` is null.\n"},"pii_confirmed_at":{"type":"string","format":"date-time","readOnly":true,"example":"2020-10-14T03:21:53.301","description":"The date and time when the Customer's PII was last confirmed to be accurate\n"},"pool_uids":{"type":"array","description":"A list of uids referring to Pools belonging to this Customer.","items":{"type":"string","example":"HiuQZJNjCd79LLYq, NoPJB9g9ZQTh5qMv"},"readOnly":true},"primary_customer_uid":{"type":"string","description":"The UID of the primary Customer. Null unless the customer type is `secondary`.","readOnly":true,"nullable":true,"example":null},"profile_responses":{"type":"array","description":"A list of Profile Responses submitted by the Customer","items":{"type":"object","properties":{"profile_requirement":{"type":"string","description":"A statement that requires a response in order to onboard a Customer for a Product","example":"Please provide your approximate annual income in USD."},"profile_response":{"type":"string","description":"The Customer's response to the Profile Requirement as a single string value.","example":"Profile response"},"profile_requirement_uid":{"type":"string","description":"A UID referring to the Profile Requirement","example":"ptRLF7nQvy8VoqM1"}}},"readOnly":true},"program_uid":{"type":"string","description":"A UID referring to the program this customer belongs to","example":"kaxHFJnWvJxRJZxr","readOnly":true},"secondary_customer_uids":{"type":"array","description":"The UIDs of secondary Customers. Null unless the customer type is `primary`.","items":{"type":"string","example":"464QyebpxbBNrGkX"},"readOnly":true,"nullable":true},"status":{"type":"string","description":"A value indicating the overall state of this Customer.\n","enum":["initiated","queued","identity_verified","active","manual_review","rejected","pending_archival","archived","under_review"],"readOnly":true},"total_balance":{"type":"string","description":"Total asset owned by the customer in US dollars","readOnly":true,"example":"12345.67"},"archived_at":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"example":null,"description":"If the Customer's status is `archived` this will have the time at which they were archived.\n"}}},{"type":"object","properties":{"details":{"$ref":"#/paths/~1customers~1%7Buid%7D/put/requestBody/content/application~1json/schema/properties/details"}}}]},"examples":{"empty_customer":{"value":{"activated_at":"2019-10-16T03:21:53.301Z","created_at":"2019-10-15T03:21:53.301Z","customer_type":"primary","details":{"first_name":null,"middle_name":null,"last_name":null,"suffix":null,"phone":null},"email":"Cletus_Borer@hotmail.com","external_uid":"0396a8f6-37d5-4386-bb63-86987ac88132","client_verified":false,"kyc_status":null,"lock_reason":null,"locked_at":null,"pool_uids":["1rNd8vRVa4GX84vi"],"primary_customer_uid":null,"program_uid":"Sw9DjTGJq5L1ctZN","secondary_customer_uids":[],"status":"initiated","total_balance":"0","uid":"uKxmLxUEiSj5h4M3","archived_at":null}}}}}}}}},"/customers/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Customers"],"summary":"Get a single Customer","description":"Retrieve overall status about a Customer as well as their total Asset Balances across all accounts.\n","responses":{"200":{"description":"A single Customer is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1customers/post/responses/201/content/application~1json/schema"}}}}}},"put":{"tags":["Customers"],"summary":"Adjust Customer Data","description":"Submit or update a Customer's personally identifiable information (PII) after the Customer is created. Before a Customer has been onboarded to a product with [Customer Product](https://developers.newline53.com/reference/post_customer-products), this endpoint may be used to update or remove any details without validations. After the Customer has been onboarded to a product, all validations will be enforced.\n\nThis endpoint is used to supply the remaining personally identifiable information (PII) for each Customer after they are created. The PII for a Customer must be submitted in full. Newline will not accept your request if any field is incomplete or missing.\n\nPII can be edited for a Customer up until a valid request is sent to the Customer Product endpoint. Once a Customer is in a status of Active, subsequent calls to this endpoint will result in additional KYC/AML evaluations. Each KYC/AML evaluation will result in a billable event for your Program. Please work with Newline on how you plan to implement PII modifications for your Customers.\n\nOnly first_name, middle_name, last_name, suffix, email, phone, and address will be editable after a Customer is in a status of Active. Once Customer data is adjusted, the pii_confirmed_at field on the Customer record will be updated.\n\nNewline accepts Tax Identifier Number in the Social Security Number field of the API. Newline performs validation on the SSN field supplied with a Customer to prevent invalid SSN values. Newline will reject a Customer record with a SSN value that does not adhere to the following parameters:\n\n- The 1st part, 3-digits, may not include 000, 666\n- The 2nd part, 2-digits, may range from 01 to 99\n- The 3rd part, 4-digits, may range from 0001 to 9999\n\nWe will accept SSN and TIN in the SSN field of the /customers endpoint.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"external_uid":{"type":"string","nullable":true,"description":"An optional Customer identifier supplied by the Partner. If supplied, must be unique among the collection of all Partner's Customers.\n","example":"partner-generated-id"},"email":{"type":"string","description":"Email of the Customer","example":"olive.oyl@newline53.com","nullable":true},"details":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"An object containing the supplied identifying information for the Customer","properties":{"first_name":{"type":"string","description":"1-40 characters","nullable":true,"example":"Olive"},"middle_name":{"type":"string","description":"1-40 characters","nullable":true,"example":"Olivia"},"last_name":{"type":"string","description":"1-40 characters","nullable":true,"example":"Oyl"},"suffix":{"type":"string","description":"1-30 characters","nullable":true,"example":"Jr."}}},{"type":"object","properties":{"phone":{"type":"string","example":"5555551212","description":"Exactly 10 digits long (no hyphens, parentheses, or spaces)","nullable":true,"pattern":"^\\d{10}$"}}}]},{"type":"object","description":"An object containing the supplied identifying information for the Customer","properties":{"business_name":{"type":"string","description":"Required for customers of type `sole_proprietor` and discarded otherwise. 1-256 alphanumeric characters.","nullable":true,"example":"Oliver's Olive Emporium"}}}]},{"type":"object","properties":{"ssn":{"type":"string","writeOnly":true,"example":"111-22-3333","description":"Follows pattern 'ddd-dd-dddd'. Required for `primary` or `sole_proprietor` customers.","nullable":true,"pattern":"^\\d{3}-\\d{2}-\\d{4}$"},"ssn_last_four":{"type":"string","readOnly":true,"nullable":true,"example":"3333"},"dob":{"type":"string","format":"date","description":"Follows pattern 'YYYY-MM-DD'","nullable":true,"example":"1919-12-08"},"address":{"type":"object","properties":{"street1":{"type":"string","description":"Maximum 35 characters","maxLength":35,"nullable":true,"example":"123 Abc St."},"street2":{"type":"string","description":"Maximum 35 characters","maxLength":35,"nullable":true,"example":"Suite 4A"},"city":{"type":"string","description":"Maximum 35 characters","maxLength":35,"nullable":true,"example":"Chicago"},"state":{"type":"string","description":"2 characters. Must be a valid US state abbreviation.","pattern":"^\\w{2}$","nullable":true,"example":"IL"},"postal_code":{"type":"string","description":"5-digit string. ZIP+4 is allowed.","pattern":"^\\d{5}(-\\d{4})?$","nullable":true,"example":"60301"}},"required":["street1","city","state","postal_code"]}}}]}}}}}},"responses":{"200":{"description":"The updated Customer resource is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1customers/post/responses/201/content/application~1json/schema"}}}}}},"delete":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"tags":["Customers"],"summary":"Archive a Customer","description":"Archiving a Customer refunds any remaining balance, closes all of their active Synthetic and Custodial Accounts and closes their Debit Cards. This process can take up to 8 business days to complete as the Transfers take place.\n\nWhen archiving a customer, you can prevent them from reapplying to your program by setting `can_apply_again` to false. If you do not set any value, `can_apply_again` defaults to true.\n\nWhen a request to archive a Customer is first received, the customer status will update to `pending_archival` and their accounts will be locked. When the archival process is complete, their customer status will update to `archived`. For a customer to move to the `archived` status, they must carry a $0 balance and have no pending transactions.\n\nIf the Customer has a positive balance across any accounts and a connected external account, Newline will initiate an ACH transfer to zero out the account balance and move the customer to the `archived` status.\n\nIf the Customer does not have an external account or the ACH transfer fails, Newline will mail a paper check to the Customer address on file to zero out the account balance and move the customer to the `archived` status.\n\nIf the Customer has a negative balance across any accounts, the negative account balances must be brought up to or greater than $0.00 before the archival workflow can continue.\n\nOnce archived, a Customer's records will still be available for historical purposes (according to the bank’s record retention schedule), but they will not be able to open any new Accounts. The Customer can still apply again as long as `can_apply_again` is not set to false.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"archive_note":{"type":"string","example":"for inactivity","nullable":true},"can_apply_again":{"type":"boolean","nullable":true,"default":true},"destination_synthetic_account_uid":{"type":"string","description":"UID of an active external Synthetic Account to which the Customer's funds should be sent, if any. Required if the Customer has multiple active external Synthetic Accounts.\n","example":"oBASVwLQB4RojU5X"}}}}}},"responses":{"200":{"description":"Customer has begun the archive process.","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1customers/post/responses/201/content/application~1json/schema"}}}}}}},"/pools":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Pools"],"summary":"List Pools","description":"Retrieves a list of Pools filtered by the given parameters.\n","parameters":[{"name":"customer_uid","in":"query","schema":{"type":"string","example":"uKxmLxUEiSj5h4M3"},"description":"Filter by Customer. Multiple values are allowed, e.g. `customer_uid[]=uKxmLxUEiSj5h4M3&customer_uid[]=y9reyPMNEWuuYSC1`.\n"},{"name":"limit","in":"query","schema":{"type":"integer","default":100},"description":"Maximum number of items to retrieve. This filter is automatically applied with the default value if not given.\n"},{"name":"offset","in":"query","schema":{"type":"integer","default":0},"description":"Index of the items to start retrieving from"}],"responses":{"200":{"description":"A list of Pools is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"total_count":{"type":"integer","description":"Total count of items available to retrieve","example":1},"count":{"type":"integer","description":"Number of items retrieved","example":1},"limit":{"type":"integer","description":"Maximum number of items to retrieve","example":100},"offset":{"type":"integer","description":"Index of the first item to retrieve","example":0}}},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/paths/~1pools~1%7Buid%7D/get/responses/200/content/application~1json/schema"}}}}]},"examples":{"pool_list":{"value":{"total_count":4,"count":2,"limit":2,"offset":0,"data":[{"uid":"wTSMX1GubP21ev2h","name":"multi-byte success","owner_customer_uid":"uKxmLxUEiSj5h4M3","customer_uids":["uKxmLxUEiSj5h4M3","ivxTYrJtwrMC4f6w"]},{"uid":"7UvkHn3Ss9AbWe2c","name":"Fundamental Frozen","owner_customer_uid":"y9reyPMNEWuuYSC1","customer_uids":["y9reyPMNEWuuYSC1","6TbfhQFQteurvK3Y"]}]}}}}}}}}},"/pools/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"name":"uid","in":"path","schema":{"type":"string"},"required":true,"description":"Newline-generated unique id resource specific to the current endpoint"}],"get":{"tags":["Pools"],"summary":"Get a single Pool","description":"Retrieve overall status about a Pool as well as its total Asset Balances across all associated accounts.","responses":{"200":{"description":"A single Pool 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"},{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/schema/allOf/0/allOf/0/allOf/2"}]},{"required":["name","owner_customer_uid"],"type":"object","properties":{"owner_customer_uid":{"type":"string","example":"EhrQZJNjCd79LLYq"},"customer_uids":{"type":"array","items":{"type":"string","description":"A list of UIDs belonging to the Customers in this Pool","example":["EhrQZJNjCd79LLYq","PbqZThW5fhQUYRx1"]}}}}]}}}}}}},"/products":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Products"],"summary":"List Products","description":"Products filtered by the given parameters.\n","parameters":[{"name":"program_uid","in":"query","schema":{"type":"string","example":"pQtTCSXz57fuefzp"},"description":"Only return Products belonging to the submitted Program"}],"responses":{"200":{"description":"A list of Products 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/~1products~1%7Buid%7D/get/responses/200/content/application~1json/schema"}}}}]}}}}}}},"/products/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Products"],"summary":"Get a single Product","description":"Retrieve overall status about a Product as well as its configuration, availability, and any associated metadata.","responses":{"200":{"description":"A single Product is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"uid":{"type":"string","description":"A unique identifier for this resource","example":"f9VncZny4ejhcPF4"},"name":{"type":"string","example":"Checking"},"description":{"type":"string","example":"Supports checking accounts"},"product_compliance_plan_uid":{"type":"string","description":"A unique identifier for a Product Compliance Plan","example":"Vxf1pY1KHbiJYo1e"},"compliance_plan_name":{"type":"string","example":"Compliance requirements for checking"},"customer_types":{"type":"array","description":"A list of customer types allowed for this Product","items":{"type":"string"},"example":["primary","sole_proprietor"]},"prerequisite_product_uids":{"type":"array","description":"A list of uids referring to Products that a Customer must onboard to before this Product is available","items":{"type":"string"},"example":["DaB7Mjj73Nz2JpHF","x2z691J9HPCWAugv"]},"profile_requirements":{"type":"array","description":"A list of Profile Requirements a Customer must provide Profile Responses to","items":{"type":"object","properties":{"profile_requirement_uid":{"type":"string","description":"A UID referring to the Profile Requirement","example":"ptRLF7nQvy8VoqM1"},"profile_requirement":{"type":"string","description":"A statement that requires response in order to onboard a Customer for a Product","example":"Please provide your approximate annual income in USD."},"category":{"type":"string","description":"an identifier by which requirements can be grouped","example":"default"},"required":{"type":"boolean","description":"an indication of whether a response is required or optional","example":true},"requirement_type":{"type":"string","description":"The type of the response values for the requirement","enum":["fixed_list","integer_greater","ordered_list","number","string"]},"response_values":{"type":"array","description":"List of valid response values, if applicable","example":["yes","no"],"items":{"type":"string"}}}}},"program_uid":{"type":"string","description":"A unique identifier for a Program","example":"W74Jrkxk8bVtvNNj"},"required_fields":{"description":"List of required PII fields per Customer type","type":"array","items":{"type":"object","properties":{"customer_type":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}}}},"example":[{"customer_type":"primary","fields":["city","dob","email","first_name","last_name","phone","postal_code","ssn","state","street1"]},{"customer_type":"sole_proprietor","fields":["business_name","city","dob","email","first_name","last_name","phone","postal_code","ssn","state","street1"]}]}}}}}}}}},"/customer_products":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Customer Products"],"summary":"List Customer Products","description":"List Customers and the Products they have onboarded onto, filtered by the given parameters.\n","parameters":[{"name":"program_uid","in":"query","schema":{"type":"string","example":"pQtTCSXz57fuefzp"},"description":"Only return Customer Products belonging to the submitted Program"},{"name":"product_uid","in":"query","schema":{"type":"string","example":"zbJbEa72eKMgbbBv"},"description":"Only return Customer Products belonging to the submitted Product"},{"$ref":"#/paths/~1pools/get/parameters/0"}],"responses":{"200":{"description":"A list of Customer Products 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/~1customer_products~1%7Buid%7D/get/responses/200/content/application~1json/schema"}}}}]}}}}}},"post":{"tags":["Customer Products"],"summary":"Onboard Customer onto a Product","description":"Submit a request to onboard a Customer onto a new product. Ensure all required Customer details have been provided with [Adjust Customer Data](https://developers.newline53.com/reference/put_customers-uid) before making this request. An error will be returned if details are missing or invalid.\n\nThe request to onboard a Customer serves as explicit confirmation from you that the Customer is ready for account opening. This event initiates the KYC/AML verification process and account opening in your Program. This is a billable event and is isolated intentionally for you to confirm that the Customer record is complete. Customer Onboarding is the event that locks the customer PII and profile responses from further edits.\n\nCustomer Onboarding is designed to work as follows:\n\n- The Customer provides complete PII as defined by the Customers endpoint\n- The Customer provides complete Customer Profile information as defined by the Product endpoint\n- You submit a request to Customer Products with the specified Product this Customer is onboarding onto\n- Newline performs a validation on the PII provided and the Customer Profile data to confirm all are valid\n\nIf the Customer passes these validations and meets the duration requirements described below, the Customer record is submitted to the KYC process","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_uid":{"type":"string","example":"S62MaHx6WwsqG9vQ","description":"A UID referring to the Customer generated by Newline.","nullable":false},"product_uid":{"type":"string","example":"pQtTCSXz57fuefzp","description":"A UID referring to the Product. Generated by Newline.","nullable":false}},"required":["customer_uid","product_uid"]}}}},"responses":{"200":{"description":"A single Customer Product is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1customer_products~1%7Buid%7D/get/responses/200/content/application~1json/schema"}}}},"422":{"description":"There was a problem with the request body","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":{"missing-details":{"description":"The given Customer was missing details.","value":{"errors":{"code":4111,"title":"Incomplete Customer details","detail":"Customer is missing required information","occurred_at":"2022-10-21T18:22:22.300Z","extra":"First name can't be blank; Last name can't be blank; City can't be blank; Dob can't be blank; Phone can't be blank; Postal code can't be blank; Ssn can't be blank; State can't be blank; Street1 can't be blank"},"status":422}}}}}}}}},"/customer_products/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Customer Products"],"summary":"Get a single Customer Product","description":"Retrieves a single Customer Product resource along with its associated Customer and Product","responses":{"200":{"description":"A single Customer Product is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"uid":{"type":"string","description":"A unique identifier for this resource","example":"Tegvs2E4TQgVYYMj"},"status":{"type":"string","description":"the status of the Customer Product onboarding","example":"active","enum":["active","created","manual_review","rejected"]},"customer_uid":{"type":"string","description":"A unique identifier for a Customer","example":"DuSzg6Ywr3cY9mw4"},"customer_email":{"type":"string","description":"The Customer's email address","example":"olive.oyl@newline53.com"},"product_uid":{"type":"string","description":"A unique identifier for a Product","example":"b8bemEKjAQhunbah"},"product_name":{"type":"string","description":"The name of the Product","example":"Checking"},"program_uid":{"type":"string","description":"A unique identifier for a Program","example":"F1oFMKafpB2Zm6ng"},"activated_at":{"type":"string","description":"The date and time at which the Customer Product became active.","format":"date-time","example":"2019-10-19T08:15:13Z"}}}}}}}}},"/custodial_accounts":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Custodial Accounts"],"summary":"List Custodial Accounts","description":"Retrieve a list of Custodial Accounts held by Fifth Third Bank for onboarded Customers. This endpoint returns active and archived accounts along with their balances.\n","parameters":[{"$ref":"#/paths/~1pools/get/parameters/0"},{"$ref":"#/paths/~1transfers/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/2"},{"name":"liability","in":"query","schema":{"type":"boolean"},"description":"Filter by liability or asset"},{"name":"type","in":"query","schema":{"type":"string","enum":["dda","dda_cash_external","dda_cash_received"],"example":"dda","description":"Filter by type. Multiple values are allowed, e.g. `type[]=dda&type[]=dda_cash_external`.\n"}}],"responses":{"200":{"description":"A list of Custodial Accounts 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/~1transfers/post/requestBody/content/application~1json/schema/allOf/0"},{"$ref":"#/paths/~1custodial_accounts~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1"}]}}}}]}}}}}}},"/custodial_accounts/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Custodial Accounts"],"summary":"Get a single Custodial Account","description":"Returns a single Custodial Account resource along with supporting details and account balances.\n","responses":{"200":{"description":"A single Custodial Account is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/0"},{"type":"object","properties":{"customer_uid":{"type":"string","description":"A UID referring to the customer this Custodial Account belongs to","example":"YrfDrfVRgpPgnhF5"},"pool_uid":{"type":"string","description":"A UID referring to the pool this Custodial Account belongs to","example":"kaxHFJnWvJxRJZxq"},"type":{"type":"string","enum":["dda","dda_cash_external","dda_cash_received"],"example":"dda","description":"`dda` accounts are liability DDA accounts. Any asset movements in or out of the brick-and-mortar accounts will be journaled in the `dda` Custodial Accounts. Balances shown in the `dda` accounts are the balances the owner Customers have.\n\n`dda_cash_external` accounts are asset accounts, representing external accounts. When ODFI transfers, initiated by a Synthetic Transfer from or to external Synthetic Accounts, are settled, the `dda_cash_external` Custodial Accounts will be credited or debited.\n\n`dda_cash_received` accounts are asset cash accounts. When RDFI transfers, initiated outside of Newline from or to Custodial Accounts, are settled, the `dda_cash_received` Custodial Accounts will be credited or debited.\n","readOnly":true},"liability":{"type":"boolean","example":true,"description":"When true, the account is a liability account; when false, an asset account. Liability Custodial Accounts represent real accounts at Financial Institutions. Asset accounts are used for accounting purposes and may be generated by Newline during events such as new custodial account creations or new external account connections.\n","readOnly":true},"name":{"type":"string","description":"A friendly name used to identify the account at the Custodial Partner. This name is sometimes shown on statements and ACH transfers. Nullable for asset Custodial Accounts.\n","nullable":true,"example":"XYZ Checking Account"},"primary_account":{"type":"boolean","description":"Used to identify the primary account when multiple Custodial Accounts exist at a single Custodial Partner\n","example":true},"status":{"type":"string","description":"A value indicating the overall state of this Custodial Account (nullable if account type is asset).\n","default":"good","enum":["active","archived"],"readOnly":true,"nullable":true},"account_errors":{"type":"array","description":"A list of errors related to this account. These are passed through during interactions with the underlying Custodial Partner and can help with resolving customer issues. Only provided for accounts that are in an `error` or `manual_review` status.\n","items":{"type":"object","properties":{"error_code":{"type":"string","example":"FI1234"},"error_name":{"type":"string","example":"DOB does not match"},"error_description":{"type":"string","example":"The given DOB does not match the known DOB for the SSN provided"}},"nullable":true},"readOnly":true},"net_usd_balance":{"type":"string","description":"The current settled balance of this Custodial Account in US Dollars. Null for Asset accounts.\n","readOnly":true,"example":"12.34"},"net_usd_pending_balance":{"type":"string","description":"The sum of all pending transactions for this Custodial Account in US Dollars. Null for Asset accounts.\n","readOnly":true,"example":"-2.56"},"net_usd_available_balance":{"type":"string","description":"The balance available to spend calculated as Normal balance less any withdrawals. Pending deposits are not included. Null for Asset accounts.\n","readOnly":true,"example":"9.78"},"net_usd_closing_balance":{"type":"string","description":"The settled balance for the account in US Dollars as of the date in net_usd_closing_balance_as_of. Null for Asset accounts.","readOnly":true,"nullable":true,"example":"9.87"},"net_usd_closing_balance_as_of":{"type":"string","description":"The date that net_usd_closing_balance was last calculated. Null for Asset accounts.","readOnly":true,"example":"2025-08-19"},"asset_balances":{"type":"array","description":"A list of balances for the various asset types held in this Custodial Account. Null for Asset accounts.\n","items":{"type":"object","properties":{"asset_quantity":{"type":"string","example":"122.11"},"asset_type":{"type":"string","example":"USD"},"current_usd_value":{"type":"string","example":"122.11"},"debit":{"type":"boolean","example":true}},"nullable":true},"readOnly":true},"routing_number":{"allOf":[{"description":"The ABA routing number associated with the Custodial Partner. Nullable if asset.\n"},{"readOnly":true},{"nullable":true},{"$ref":"#/paths/~1virtual_reference_numbers/post/requestBody/content/application~1json/schema/properties/routing_number/allOf/0"}]},"opened_at":{"type":"string","description":"The DateTime at which this account was created","format":"date-time","readOnly":true,"example":"2019-01-31T17:32:28Z"},"closed_at":{"type":"string","description":"The DateTime at which this account was closed","format":"date-time","nullable":true,"readOnly":true,"example":"2019-10-19T08:15:13Z"},"account_number_masked":{"type":"string","description":"Last 4 digits of the ACH account number. Nullable if asset.","readOnly":true,"nullable":true,"example":"9012"}},"required":["customer_uid","pool_uid","primary_account"]},{"type":"object","properties":{"account_number":{"allOf":[{"description":"The ACH account number that can be used to make transfers into/out of this account. Nullable if asset.\n"},{"readOnly":true},{"nullable":true},{"maxLength":17,"minLength":1,"type":"string","example":"123456789012","pattern":"^[0-9]{1,17}$"}]},"company_ids":{"type":"array","description":"A list of company ids associated with the Custodial Partner. Not present if asset.\n","items":{"type":"string","example":"COMPID1234"}}}}]}}}}}}},"/custodial_account_closing_balances":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Custodial Accounts"],"summary":"List Custodial Account Closing Balances","description":"Retrieves a paginated list of Custodial Account Closing balances, filtered by various parameters.","parameters":[{"name":"custodial_account_uid","in":"query","schema":{"type":"string","example":"yqyYk5b1xgXFFrXs"},"description":"Filter by Custodial Account"},{"name":"custodial_account_external_uid","in":"query","schema":{"type":"string","example":"4XkJnsfHsuqrxmeX"},"description":"Filter by Custodial Account External. Multiple values are allowed, e.g. `custodial_account_external_uid[]=4XkJnsfHsuqrxmeX&custodial_account_external_uid[]=exMDShw6yM3NHLYV`.\n"},{"$ref":"#/paths/~1pools/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/2"},{"name":"net_usd_closing_balance_as_of","in":"query","required":false,"schema":{"$ref":"#/paths/~1transactions/get/parameters/17/schema"}},{"name":"net_usd_closing_balance_before","in":"query","required":false,"schema":{"$ref":"#/paths/~1transactions/get/parameters/17/schema"}},{"name":"net_usd_closing_balance_after","in":"query","required":false,"schema":{"$ref":"#/paths/~1transactions/get/parameters/17/schema"}}],"responses":{"200":{"description":"A list of Custodial Account Closing balances 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/~1transaction_events~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/0"},{"$ref":"#/paths/~1custodial_account_closing_balances~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1"}]}}}}]}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/custodial_account_closing_balances/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Custodial Accounts"],"summary":"Get a single Custodial Account Closing Balance","responses":{"200":{"description":"A single Custodial Account Closing Balance is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1transaction_events~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/0"},{"type":"object","properties":{"custodial_account_uid":{"type":"string","description":"A unique id referring to the Custodial Account","example":"Jy8degj6iv2QngLo"},"custodial_account_external_uid":{"type":"string","description":"A unique id referring to the External Custodial Account","example":"ptRLF7nQvy8VoqM1"},"net_usd_closing_balance":{"type":"string","description":"The USD amount of the Custodial Account's closing balance","example":"12.34"},"net_usd_closing_balance_as_of":{"type":"string","format":"date","example":"1978-08-17"}}}]}}}}}}},"/synthetic_account_types":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Synthetic Accounts"],"summary":"List Synthetic Account Types","description":"Retrieve a list of Synthetic Account Types available for use in your Program. These types define the behavior and characteristics of Synthetic Accounts.","parameters":[{"name":"program_uid","in":"query","schema":{"type":"string","example":"EhrQZJNjCd79LLYq"},"description":"Only list Synthetic Account Types that are available to be used by the given Program"},{"$ref":"#/paths/~1pools/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/2"}],"responses":{"200":{"description":"A list of Synthetic Account Types 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_account_types~1%7Buid%7D/get/responses/200/content/application~1json/schema"}}}}]},"examples":{"synthetic_account_types_list":{"value":{"total_count":10,"count":4,"limit":4,"offset":0,"data":[{"description":"This Synthetic Account Type will be used to open Synthetic Accounts that will only contain a USD asset type.","name":"General for My Program","program_uid":"Sw9DjTGJq5L1ctZN","synthetic_account_category":"general","uid":"fRMwt6H14ovFUz1s"},{"description":"This Synthetic Account Type will be used to create an external Synthetic Account used for ACH transfers. The external Synthetic Account will be associated with the customer's externally connected financial institution.","name":"ACH External Account for My Program","program_uid":"Sw9DjTGJq5L1ctZN","synthetic_account_category":"ach_external","uid":"q4mdMxMtjXfdbrjn"},{"description":"This Synthetic Account Type will be used to create an external Synthetic Account used for wire transfers. The external Synthetic Account will be associated with the customer's externally connected financial institution.","name":"Wire External Account for My Program","program_uid":"Sw9DjTGJq5L1ctZN","synthetic_account_category":"wire_external","uid":"LTpFu4XV56kim8vR"},{"description":"This Synthetic Account Type will be used to create an external Synthetic Account used for instant payments. The external Synthetic Account will be associated with the customer's externally connected financial institution.","name":"Instant Payments External Account for My Program","program_uid":"Sw9DjTGJq5L1ctZN","synthetic_account_category":"instant_payment_external","uid":"gh6APuePFP2j9iFR"}]}}}}}}}}},"/synthetic_account_types/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Synthetic Accounts"],"summary":"Get a Single Synthetic Account Type","description":"Returns a single Synthetic Account Type resource along with supporting details.\n\nEnables changes to the Synthetic Account fields, including the Master Synthetic Account. The Master Synthetic Account remains identifiable by the `master_account` flag stored with the Synthetic Account record.","responses":{"200":{"description":"A single Synthetic Account Type is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1pools~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/0"},{"type":"object","properties":{"description":{"type":"string","description":"A description outlining the intended use and requirements for this program's instance of the synthetic_account_type","readOnly":true,"example":"This synthetic_account_type will be used to open synthetic_accounts for our customers that will only contain a USD asset type."},"program_uid":{"type":"string","description":"A UID referring to the Program this synthetic_account_type belongs to","readOnly":true,"example":"kaxHFJnWvJxRJZxq"},"synthetic_account_category":{"type":"string","description":"The name of the Synthetic Account Category for this type. Accounts can be in one of several categories that indicate their handling properties and defining characteristics such as 'general' or 'external'. As an example, 'external' accounts do not actually hold any assets and are instead used to represent an account at an external institution for use in initiating transfers.","readOnly":true,"enum":["general","ach_external","instant_payments_external","wire_external"]}}}]}}}}}}},"/synthetic_accounts":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Synthetic Accounts"],"summary":"List Synthetic Accounts","description":"Retrieve a list of Synthetic Accounts associated with the specified Customer and Pool. This endpoint supports filtering by account type, category, status, and sorting by balance or name.\n","parameters":[{"$ref":"#/paths/~1pools/get/parameters/0"},{"$ref":"#/paths/~1transfers/get/parameters/1"},{"$ref":"#/paths/~1transfers/get/parameters/2"},{"$ref":"#/paths/~1pools/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/2"},{"name":"synthetic_account_type_uid","in":"query","schema":{"type":"string","example":"q4mdMxMtjXfdbrjn"},"description":"Filter by Synthetic Account Type"},{"name":"synthetic_account_category","in":"query","schema":{"type":"string","enum":["general","ach_external","wire_external","instant_payments_external"]},"description":"Filter by Synthetic Account Category"},{"$ref":"#/paths/~1custodial_accounts/get/parameters/4"},{"name":"status","in":"query","schema":{"type":"string","enum":["initiated","active","archived","failed"],"example":"active","description":"Filter by status. Multiple values are allowed, e.g. `status[]=archived&status[]=failed`.\n"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["name_asc","name_desc","net_usd_balance_asc","net_usd_balance_desc","net_usd_pending_balance_asc","net_usd_pending_balance_desc","net_usd_available_balance_asc","net_usd_available_balance_desc"]}}],"responses":{"200":{"description":"A list of Synthetic Accounts 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/~1synthetic_accounts/post/requestBody/content/application~1json/schema/allOf/0/allOf/0"},{"$ref":"#/paths/~1synthetic_accounts/post/requestBody/content/application~1json/schema/allOf/0/allOf/1"},{"type":"object","properties":{"ach":{"allOf":[{"type":"object"},{"nullable":true},{"description":"Contains ACH-specific information. Only populated if the Synthetic Account is in the `ach_external` category.\n"},{"$ref":"#/paths/~1synthetic_accounts/post/requestBody/content/application~1json/schema/allOf/1/properties/ach/allOf/2"}]},"instant_payment":{"allOf":[{"type":"object"},{"nullable":true},{"description":"Contains Instant Payment-specific information. Only populated if the Synthetic Account is in the `instant_payments_external` category.\n"},{"type":"object","properties":{"counterparty_name":{"description":"Name of the business or individual who owns the counterparty Account.\n","allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_name/allOf/0"}]},"email":{"description":"Email address of the counterparty","type":"string","nullable":true,"example":"payments@veryexcellentbusiness.com"},"phone":{"nullable":true,"$ref":"#/paths/~1customers/get/responses/200/content/application~1json/schema/allOf/1/properties/data/items/allOf/2/properties/details/allOf/0/allOf/1/properties/phone"}}}]},"wire":{"allOf":[{"type":"object"},{"nullable":true},{"description":"Contains wire-specific information. Only populated if the Synthetic Account is in the `wire_external` category.\n"},{"type":"object","properties":{"counterparty_name":{"description":"Name of the business or individual who owns the counterparty Account.\n","allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_name/allOf/0"}]},"counterparty_bank_address":{"description":"Address of the financial institution where the external account is held.\n","nullable":true,"allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/0"}]},"counterparty_bank_name":{"description":"Name of the financial institution where the counterparty account is held.\n","nullable":true,"allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_bank_name/allOf/0"}]}}}]}}}]}}}}]},"examples":{"synthetic_accounts_list":{"value":{"total_count":10,"count":4,"limit":4,"offset":0,"data":[{"uid":"4XkJnsfHsuqrxmeX","external_uid":"ea8e1ccd-5893-4fcb-b09a-2b784ba7c73c","name":"Primary Account","pool_uid":"wTSMX1GubP21ev2h","synthetic_account_type_uid":"fRMwt6H14ovFUz1s","synthetic_account_category":"general","status":"active","liability":true,"net_usd_balance":"1567.13","net_usd_pending_balance":"261.83","net_usd_available_balance":"1409.88","asset_balances":[{"asset_quantity":"1567.13","asset_type":"USD","current_usd_value":"1567.13","custodial_account_uid":"DXr716uLzBm44HyP","custodial_account_name":"First Checking","debit":false}],"master_account":true,"custodial_account_uids":["DXr716uLzBm44HyP","3fRiyDdbSVv9nKW2"],"account_number_last_four":"5372","routing_number":"123456789","opened_at":"2018-05-26T23:14:27.012Z","closed_at":null,"instant_payment":null,"wire":null},{"uid":"exMDShw6yM3NHLYV","external_uid":"60689018-94e9-4870-970a-cc22f52c9c65","name":"Wire Account","pool_uid":"wTSMX1GubP21ev2h","synthetic_account_type_uid":"VMwzNGctNAbSmHXJ","synthetic_account_category":"wire_external","status":"active","liability":false,"net_usd_balance":null,"net_usd_pending_balance":null,"net_usd_available_balance":null,"asset_balances":null,"master_account":false,"custodial_account_uids":["NPeYkNMDVBWnKVXJ"],"account_number_last_four":"5372","routing_number":"123456789","opened_at":"2018-03-08T19:07:18.049Z","closed_at":null,"instant_payment":null,"wire":{"counterparty_name":"Aunt Sandy","counterparty_bank_address":{"line1":"334 Swamp St","line2":"Bagdad, FL 32530","line3":null,"country":"US"},"counterparty_bank_name":"First Beach Bank"}},{"uid":"nbDrqhrFAjqUdxBG","external_uid":"f03fd9ff-a0a1-4e3c-981f-4d845836a2ce","name":"Instant Payments Account","pool_uid":"wTSMX1GubP21ev2h","synthetic_account_type_uid":"fRMwt6H14ovFUz1s","synthetic_account_category":"instant_payment_external","status":"active","liability":false,"net_usd_balance":null,"net_usd_pending_balance":null,"net_usd_available_balance":null,"asset_balances":null,"master_account":false,"custodial_account_uids":["DcMfBTHj94dsi471"],"account_number_last_four":"5372","routing_number":"123456789","opened_at":"2022-02-22T23:14:27.012Z","closed_at":null,"instant_payment":{"counterparty_name":"Paloma's Premium Polymers","email":"paloma@premiumpolymers.co","phone":"5555551212"},"wire":null},{"uid":"uu2XSYPAB57iX5wi","external_uid":"g13fd9ff-a0a1-4a3c-782f-1b8458f6a2ce","name":"ACH Account","pool_uid":"wTSMX1GubP21ev2h","synthetic_account_type_uid":"9gdN9noL2L1nj9R8","synthetic_account_category":"ach_external","status":"active","liability":false,"net_usd_balance":null,"net_usd_pending_balance":null,"net_usd_available_balance":null,"asset_balances":null,"master_account":false,"custodial_account_uids":["zH9WRBskMKiyu3D9"],"account_number_last_four":"7890","routing_number":"123456789","opened_at":"2021-05-12T23:14:27.012Z","closed_at":null,"ach":{"counterparty_name":"Arnold Arnoldson","account_type":"checking"}}]}}}}}}}},"post":{"tags":["Synthetic Accounts"],"summary":"Create a New Synthetic Account","description":"Create a new Synthetic Account in the Pool with the provided specification.\n\nExternal Synthetic Accounts are counterparty records that represent accounts at external financial institutions. They contain all the necessary information to execute a payment. For specifics about each payment rail's requirements, refer to our [Payment Rails](https://developers.newline53.com/docs/payment-rails) guides.","requestBody":{"description":"See [GET /synthetic_account_types](/reference/get_synthetic-account-types) for the list of available types\n","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"allOf":[{"$ref":"#/paths/~1transaction_events~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/0"},{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/0/allOf/1"},{"type":"object","properties":{"name":{"type":"string","description":"A unique name, per pool, to identify the resource","example":"New Resource Name"}}}]},{"type":"object","properties":{"pool_uid":{"type":"string","description":"The unique id of the Synthetic Account's pool","example":"kaxHFJnWvJxRJZxq"},"synthetic_account_type_uid":{"type":"string","description":"A unique id referring to the Synthetic Account's type.\n","example":"fRMwt6H14ovFUz1s"},"custodial_account_uids":{"type":"array","description":"Array of unique ids of the Custodial Accounts this Synthetic Account is associated with.\n","items":{"type":"string"},"readOnly":true},"synthetic_account_category":{"type":"string","description":"The name of the Synthetic Account Category associated with the Synthetic Account Type for this account. Refer to the Synthetic Account Type for details.","readOnly":true,"enum":["general","ach_external","instant_payments_external","wire_external"]},"status":{"type":"string","description":"A value indicating the overall state of this Synthetic Account.\n","enum":["initiated","active","archived","failed"],"example":"active","readOnly":true},"liability":{"type":"boolean","description":"Liability or asset. Any Synthetic Account created via [POST /synthetic_accounts](/reference/post_synthetic-accounts) is a liability account, except for external accounts. Some asset Synthetic Accounts are automatically created by Newline during Customer onboarding for accounting purposes.","readOnly":true},"net_usd_balance":{"type":"string","description":"The current settled balance of this account in US Dollars. This field will be null for synthetic_account_types in an external category (`ach_external`, `instant_payments_external`, `wire_external`).","readOnly":true,"nullable":true,"example":"12.34"},"net_usd_pending_balance":{"type":"string","description":"The sum of all pending transactions for this account in US Dollars. This field will be null for Synthetic Account Types in an external category (`ach_external`, `instant_payments_external`, `wire_external`).","readOnly":true,"nullable":true,"example":"-2.56"},"net_usd_available_balance":{"type":"string","description":"The balance available to spend calculated as the settled balance less any pending withdrawals. Pending deposits are not included. This field will be null for Synthetic Account Types in an external category (`ach_external`, `instant_payments_external`, `wire_external`).","readOnly":true,"nullable":true,"example":"9.78"},"net_usd_closing_balance":{"type":"string","description":"The settled balance for the account in US Dollars as of the date in net_usd_closing_balance_as_of. This field will be null for Synthetic Account Types in an external category (`ach_external`, `instant_payments_external`, `wire_external`).","readOnly":true,"nullable":true,"example":"9.87"},"net_usd_closing_balance_as_of":{"type":"string","description":"The date that net_usd_closing_balance was last calculated. This field will be null for Synthetic Account Types in an external category (`ach_external`, `instant_payments_external`, `wire_external`).","readOnly":true,"example":"2025-08-19"},"asset_balances":{"type":"array","description":"A list of balances for the various asset types held in Custodial Accounts associated with this Synthetic Account.\n","items":{"type":"object","properties":{"asset_quantity":{"type":"string","example":12.23},"asset_type":{"type":"string","example":"USD"},"current_usd_value":{"type":"string","example":122.12},"custodial_account_uid":{"type":"string","example":"wZgfnLrLJcCAscnH"},"custodial_account_name":{"type":"string","example":"First Checking"},"debit":{"type":"boolean","example":true}},"nullable":true},"readOnly":true},"master_account":{"type":"boolean","description":"Used to identify the Master Synthetic Accounts that exist for every Program Customer. Master Synthetic Accounts are the default accounts where any unknown custodial transactions will settle and cannot be archived while a Program Customer is still active.\n","readOnly":true,"example":true},"routing_number":{"allOf":[{"description":"The ABA routing number (if any) associated with this account. Some Synthetic Account Types require this field to be submitted along with the POST request. For example, any Synthetic Account Type from the `ach_external` or the `wire_external` category will require a `routing_number`. Submitting a `routing_number` with a Synthetic Account Type that does not require one will result in the routing number being ignored."},{"nullable":true},{"$ref":"#/paths/~1virtual_reference_numbers/post/requestBody/content/application~1json/schema/properties/routing_number/allOf/0"}]},"account_number_last_four":{"type":"string","description":"Last 4 digits of the Synthetic Account number","readOnly":true,"nullable":true,"example":"9012"},"opened_at":{"type":"string","description":"The DateTime at which this account was created","format":"date-time","readOnly":true,"example":"2019-01-31T17:32:28Z"},"closed_at":{"type":"string","description":"The DateTime at which this account was closed. This value will be present if the status is `archived` or `failed`.\n","format":"date-time","nullable":true,"readOnly":true,"example":"2019-10-19T08:15:13Z"}}},{"type":"object","properties":{"account_number":{"allOf":[{"description":"The account number (if any) associated with this account. Some Synthetic Account Types require this field to be submitted along with the POST request. For example, any Synthetic Account Type from the `ach_external` or the `wire_external` category will require an `account_number`. Submitting an `account_number` with a Synthetic Account Type that does not require one will result in the account number being ignored."},{"nullable":true},{"$ref":"#/paths/~1custodial_accounts~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/2/properties/account_number/allOf/3"}]}}}]},{"type":"object","properties":{"external_processor_token":{"type":"string","description":"The processor token required to create certain Synthetic Account Types.","nullable":true,"example":"processor-sandbox-96d86f35-ef58-4e4a-826f-4870b5d677f2"},"ach":{"allOf":[{"type":"object"},{"description":"Contains ACH-specific information. Only populated if the Synthetic Account is in the `ach_external` category.\n"},{"type":"object","properties":{"account_type":{"description":"The type of ACH account","type":"string","enum":["checking","savings"],"example":"checking"},"counterparty_name":{"description":"Name of the business or individual who owns the external account. Conditional maximum character length: for all newline supported SEC codes other than CIE, the counterparty_name can be 22 characters. For CIE SEC codes, the counterparty_name can be up to 15 characters.\n","maxLength":22,"type":"string","example":"Thelma's Flooring LLC"}}}],"required":["account_type","counterparty_name"]},"instant_payment":{"description":"Contains Instant Payment-specific information. Only populated if the Synthetic Account is in the `instant_payments_external` category.\n","allOf":[{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/schema/allOf/1/properties/instant_payment"}],"required":["counterparty_address","counterparty_name"]},"wire":{"allOf":[{"type":"object"},{"description":"Contains wire-specific information. Only populated if the Synthetic Account is in the `wire_external` category.\n"},{"allOf":[{"type":"object","properties":{"counterparty_address":{"nullable":true,"description":"Address of the business or individual who owns the external account.\n","allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/0"}],"example":{"line1":"234 Xyz Rd","line2":"APT 5","line3":"Boston, MA 02110","country":"US"}},"counterparty_name":{"description":"Name of the business or individual who owns the counterparty Account. Required for synthetic accounts in the wire_external category. Maximum 35 characters.\n","allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_name/allOf/0"}]},"counterparty_bank_address":{"nullable":true,"description":"Address of the financial institution where the external account is held.\n","allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/0"}]},"counterparty_bank_name":{"nullable":true,"description":"Name of the financial institution where the counterparty account is held.\n","allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_bank_name/allOf/0"}]}}}]}],"required":["counterparty_name"]}}}],"required":["external_uid","name","pool_uid","synthetic_account_type_uid"]},"examples":{"new_synthetic_account":{"value":{"name":"Spinach Fund","pool_uid":"wTSMX1GubP21ev2h","synthetic_account_type_uid":"fRMwt6H14ovFUz1s"}}}}}},"responses":{"201":{"description":"A new Synthetic Account is created","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1synthetic_accounts/post/requestBody/content/application~1json/schema/allOf/0"},{"type":"object","properties":{"ach":{"allOf":[{"type":"object"},{"description":"Contains ACH-specific information. Only populated if the Synthetic Account is in the `ach_external` category.\n"},{"$ref":"#/paths/~1synthetic_accounts/post/requestBody/content/application~1json/schema/allOf/1/properties/ach/allOf/2"}]},"instant_payment":{"type":"object","properties":{"counterparty_address":{"description":"Address of the business or individual who owns the external account.\n","allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/1"}]},"counterparty_name":{"description":"Name of the business or individual who owns the counterparty Account.\n","type":"string","maxLength":140,"pattern":"^[a-zA-Z0-9.' -]{1,140}$","example":"Marge's Roofing Inc"},"email":{"description":"Email address of the counterparty","type":"string","nullable":true,"example":"payments@veryexcellentbusiness.com"},"phone":{"nullable":true,"$ref":"#/paths/~1customers/get/responses/200/content/application~1json/schema/allOf/1/properties/data/items/allOf/2/properties/details/allOf/0/allOf/1/properties/phone"}}},"wire":{"allOf":[{"type":"object"},{"description":"Contains wire-specific information. Only populated if the Synthetic Account is in the `wire_external` category.\n"},{"$ref":"#/paths/~1synthetic_accounts/post/requestBody/content/application~1json/schema/allOf/1/properties/wire/allOf/2"}]}}}]},"examples":{"general_synthetic_account":{"value":{"uid":"exMDShw6yM3NHLYV","external_uid":"60689018-94e9-4870-970a-cc22f52c9c65","name":"Spinach Fund","pool_uid":"wTSMX1GubP21ev2h","synthetic_account_type_uid":"fRMwt6H14ovFUz1s","synthetic_account_category":"general","status":"active","liability":true,"net_usd_balance":"0","net_usd_pending_balance":"0","net_usd_available_balance":"0","asset_balances":[{"asset_quantity":"769.65","asset_type":"USD","current_usd_value":"769.65","custodial_account_uid":"4uJMJjNd5wjzPaCj","custodial_account_name":"Second Checking","debit":false}],"master_account":false,"routing_number":"123456789","account_number":"1234567890","account_number_last_four":"7890","opened_at":"2018-03-08T19:07:18.049Z","closed_at":null,"custodial_account_uids":["4uJMJjNd5wjzPaCj","3fRiyDdbSVv9nKW2"],"wire":null}},"instant_payment_synthetic_account":{"value":{"uid":"nbDrqhrFAjqUdxBG","external_uid":"f03fd9ff-a0a1-4e3c-981f-4d845836a2ce","name":"Instant Payments Account","pool_uid":"wTSMX1GubP21ev2h","synthetic_account_type_uid":"fRMwt6H14ovFUz1s","synthetic_account_category":"instant_payment_external","status":"active","liability":false,"net_usd_balance":null,"net_usd_pending_balance":null,"net_usd_available_balance":null,"asset_balances":null,"master_account":false,"custodial_account_uids":["DcMfBTHj94dsi471"],"account_number":null,"account_number_last_four":"9012","routing_number":"123456789","opened_at":"2022-02-22T23:14:27.012Z","closed_at":null,"instant_payment":{"counterparty_address":{"street_number":"242","street1":"Marble St","city":"Marblehead","state":"MA","postal_code":"21945","country":"US"},"counterparty_name":"Paloma's Premium Polymers","email":"paloma@premiumpolymers.co","phone":"5555551212"}}},"wire_synthetic_account":{"value":{"uid":"exMDShw6yM3NHLYV","external_uid":"60689018-94e9-4870-970a-cc22f52c9c65","name":"Wire Account","pool_uid":"wTSMX1GubP21ev2h","synthetic_account_type_uid":"VMwzNGctNAbSmHXJ","synthetic_account_category":"wire_external","status":"active","liability":false,"net_usd_balance":null,"net_usd_pending_balance":null,"net_usd_available_balance":null,"asset_balances":null,"master_account":false,"custodial_account_uids":["NPeYkNMDVBWnKVXJ"],"account_number":null,"account_number_last_four":"9012","routing_number":"123456789","opened_at":"2018-03-08T19:07:18.049Z","closed_at":null,"wire":{"counterparty_name":"Aunt Sandy","counterparty_bank_address":{"line1":"334 Swamp St","line2":"Bagdad, FL 32530","line3":null,"country":"US"},"counterparty_bank_name":"First Beach Bank","counterparty_address":{"line1":"333 Swamp St","line2":"Bagdad, FL 32530","line3":null,"country":"US"}}}},"ach_account":{"value":{"uid":"uu2XSYPAB57iX5wi","external_uid":"g13fd9ff-a0a1-4a3c-782f-1b8458f6a2ce","name":"ACH Account","pool_uid":"wTSMX1GubP21ev2h","synthetic_account_type_uid":"9gdN9noL2L1nj9R8","synthetic_account_category":"ach_external","status":"active","liability":false,"net_usd_balance":null,"net_usd_pending_balance":null,"net_usd_available_balance":null,"asset_balances":null,"master_account":false,"custodial_account_uids":["zH9WRBskMKiyu3D9"],"account_number":null,"account_number_last_four":"7890","routing_number":"123456789","opened_at":"2021-05-12T23:14:27.012Z","closed_at":null,"ach":{"counterparty_name":"Arnold Arnoldson","account_type":"checking"}}}}}}},"409":{"description":"A new Synthetic Account is NOT created if the external_uid given is present but not unique\n","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":{"post_error_response":{"value":{"errors":[{"code":2002,"title":"Synthetic Account already exists","detail":"Synthetic Account could not be created or updated","occurred_at":"2018-03-08T19:07:18.049Z"}],"status":409}}}}}}}}},"/synthetic_accounts/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Synthetic Accounts"],"summary":"Get a single Synthetic Account","description":"Returns a single Synthetic Account resource along with supporting details and account balances.\n\nNote: Newline will suppress the `account_number` value for Synthetic Accounts in the `ach_external`, `wire_external`, and `instant_payments_external` categories. The `account_number_last_four` value will be returned in the response to help identify these Synthetic Accounts.","responses":{"200":{"description":"A single Synthetic Account is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/schema"},"examples":{"general_synthetic_account":{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/examples/general_synthetic_account"},"instant_payment_synthetic_account":{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/examples/instant_payment_synthetic_account"},"wire_synthetic_account":{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/examples/wire_synthetic_account"},"ach_account":{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/examples/ach_account"}}}}}}},"put":{"tags":["Synthetic Accounts"],"summary":"Update the Synthetic Account metadata","description":"Enables changes to the Synthetic Account fields, including the Master Synthetic Account. The Master Synthetic Account remains identifiable by the `master_account` flag stored with the Synthetic Account record.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1synthetic_accounts/post/requestBody/content/application~1json/schema/allOf/0"},{"type":"object","properties":{"note":{"type":"string","description":"A reason for the Synthetic Account metadata change\n"},"ach":{"allOf":[{"type":"object"},{"description":"Contains ACH-specific information. Only populated if the Synthetic Account is in the `ach_external` category.\n"},{"$ref":"#/paths/~1synthetic_accounts/post/requestBody/content/application~1json/schema/allOf/1/properties/ach/allOf/2"}]},"instant_payment":{"type":"object","description":"Contains Instant Payment-specific information. Only populated if the Synthetic Account is in the `instant_payments_external` category.\n","allOf":[{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/schema/allOf/1/properties/instant_payment"}]},"wire":{"type":"object","description":"Contains wire-specific information. Only populated if the Synthetic Account is in the `wire_external` category.\n","allOf":[{"$ref":"#/paths/~1synthetic_accounts/post/requestBody/content/application~1json/schema/allOf/1/properties/wire/allOf/2"}]}}}]}}}},"responses":{"200":{"description":"The updated Synthetic Account resource is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/schema"},"examples":{"general_synthetic_account":{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/examples/general_synthetic_account"},"instant_payment_synthetic_account":{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/examples/instant_payment_synthetic_account"},"wire_synthetic_account":{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/examples/wire_synthetic_account"},"ach_account":{"$ref":"#/paths/~1synthetic_accounts/post/responses/201/content/application~1json/examples/ach_account"}}}}},"400":{"description":"A Synthetic Account is not updated if a required parameter is missing\n","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":{"missing_param_error":{"value":{"errors":[{"code":1003,"title":"Missing Request Parameter","detail":"At least one parameter is missing. Cannot continue with the request","extra":"name cannot be null or blank","occurred_at":"2018-03-08T19:07:18.049Z"}],"status":400}}}}}}}},"delete":{"tags":["Synthetic Accounts"],"summary":"Archive a Synthetic Account","description":"In order to archive a Synthetic Account, the account must:\n\n- not be a Master Synthetic Account i.e. `master_account` must be false.\n- have zero balance.\n- have no pending Transfers.\n\nMaster Synthetic Accounts are archived when the Program Customer is archived ([DELETE /customers/:uid](https://developers.newline53.com/reference/delete_customers-uid)).","responses":{"204":{"description":"Synthetic Account is archived successfully","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}}},"422":{"description":"A Synthetic Account is not archived\n","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":{"outstanding_balance_error":{"value":{"errors":[{"code":2004,"title":"Cannot archive Synthetic Account with balance","detail":"A Synthetic Account with a non-zero balance cannot be archived","extra":"Its balance is not 0","occurred_at":"2018-03-08T19:07:18.049Z"}],"status":422}},"pending_transfer_error":{"value":{"errors":[{"code":2005,"title":"Cannot archive Synthetic Account with pending Transfer","detail":"A Synthetic Account with a pending Transfer cannot be archived","extra":"It has a pending transfer","occurred_at":"2018-03-08T19:07:18.049Z"}],"status":422}}}}}}}}},"/synthetic_account_closing_balances":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Synthetic Accounts"],"summary":"List Synthetic Account Closing Balances","description":"Retrieves a paginated list of Synthetic Account Closing balances, filtered by various parameters.","parameters":[{"$ref":"#/paths/~1transfers/get/parameters/3"},{"name":"synthetic_account_external_uid","in":"query","schema":{"type":"string","example":"4XkJnsfHsuqrxmeX"},"description":"Filter by Synthetic Account External. Multiple values are allowed, e.g. `synthetic_account_external_uid[]=4XkJnsfHsuqrxmeX&synthetic_account_external_uid[]=exMDShw6yM3NHLYV`.\n"},{"$ref":"#/paths/~1pools/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/2"},{"name":"net_usd_closing_balance_as_of","in":"query","required":false,"schema":{"$ref":"#/paths/~1transactions/get/parameters/17/schema"}},{"name":"net_usd_closing_balance_before","in":"query","required":false,"schema":{"$ref":"#/paths/~1transactions/get/parameters/17/schema"}},{"name":"net_usd_closing_balance_after","in":"query","required":false,"schema":{"$ref":"#/paths/~1transactions/get/parameters/17/schema"}}],"responses":{"200":{"description":"A list of Synthetic Account Closing balances 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/~1transaction_events~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/0"},{"$ref":"#/paths/~1synthetic_account_closing_balances~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1"}]}}}}]}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/synthetic_account_closing_balances/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Synthetic Accounts"],"summary":"Get a single Synthetic Account Closing Balance","responses":{"200":{"description":"A single Synthetic Account Closing Balance 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":{"synthetic_account_uid":{"type":"string","description":"A unique id referring to the Synthetic Account","example":"Jy8degj6iv2QngLo"},"synthetic_account_external_uid":{"type":"string","description":"A unique id referring to the External Synthetic Account","example":"ptRLF7nQvy8VoqM1"},"net_usd_closing_balance":{"type":"string","description":"The USD amount of the Synthetic Account's closing balance","example":"12.34"},"net_usd_closing_balance_as_of":{"type":"string","format":"date","example":"1978-08-17"}}}]}}}}}}},"/transfers":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Transfers"],"summary":"List Transfers","description":"Retrieves a list of Transfers filtered by the given parameters. Transfers facilitate the movement of assets between accounts, enabling transactions such as payments and withdrawals.\n","parameters":[{"$ref":"#/paths/~1pools/get/parameters/0"},{"name":"external_uid","in":"query","schema":{"type":"string","example":"client-generated-id"},"description":"A unique, immutable id provided by the Client. Multiple values are allowed e.g. `external_uid[]=uKxmLxUEiSj5h4M3&external_uid[]=y9reyPMNEWuuYSC1`."},{"name":"pool_uid","in":"query","schema":{"type":"string","example":"wTSMX1GubP21ev2h"},"description":"Filter by pool. Multiple values are allowed, e.g. `pool_uid[]=wTSMX1GubP21ev2h&pool_uid[]=7UvkHn3Ss9AbWe2c`.\n"},{"name":"synthetic_account_uid","in":"query","schema":{"type":"string","example":"4XkJnsfHsuqrxmeX"},"description":"Filter by Synthetic Account. Multiple values are allowed, e.g. `synthetic_account_uid[]=4XkJnsfHsuqrxmeX&synthetic_account_uid[]=exMDShw6yM3NHLYV`.\n"},{"$ref":"#/paths/~1pools/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/2"},{"name":"sort","in":"query","schema":{"type":"string","enum":["created_at_asc","created_at_desc"]}}],"responses":{"200":{"description":"A list of Transfers is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1pools/get/responses/200/content/application~1json/schema/allOf/0"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/paths/~1transfers/post/responses/201/content/application~1json/schema/allOf/0"}}}}]},"examples":{"transactions":{"value":{"total_count":3,"count":3,"limit":3,"offset":1,"data":[{"uid":"EhrQZJNjCd79LLYq","external_uid":"partner-generated-id","source_synthetic_account_uid":"4XkJnsfHsuqrxmeX","destination_synthetic_account_uid":"exMDShw6yM3NHLYV","initiating_customer_uid":"iDtmSA52zRhgN4iy","destination_customer_uid":"iDtmSA52zRhgN4iy","status":"pending","initiator_type":"transmitter","created_at":"2019-10-14T03:21:53.301Z","transaction_uids":[],"usd_transfer_amount":33.12,"wire":{"intermediary_bank_address":{"line1":"345 Def Ave","line2":"San Francisco","line3":"CA 94016","country":"US"},"intermediary_bank_name":"Fidelity Fiduciary Bank","intermediary_bank_routing_number":"923456789","wire_transmitter":{"name":"Top Tier Tacos","transmitter_identifier":"123456789","street_number":123,"street1":"Abc St.","city":"Boring","state":"OR","postal_code":97009}}},{"uid":"VeYqeb1iHqBR4LEi","external_uid":"partner-created-id","source_synthetic_account_uid":"ABv3vs5yVypxpGgF","destination_synthetic_account_uid":"RRbw63TF4o1vg2RQ","initiating_customer_uid":"oBugADTMCMEU4sfE","destination_customer_uid":"22PBwMT88qCQWMSg","status":"settled","initiator_type":"transmitter","created_at":"2019-10-14T03:21:53.301Z","transaction_uids":["d8WUMmm4dZfMpLeh"],"usd_transfer_amount":32.13,"instant_payment":{"instant_payment_transmitter":{"name":"Royalty Asset Management","transmitter_identifier":"123456789","street_number":123,"street1":"Abc St.","city":"Boring","state":"OR","postal_code":97009},"memo":"To unfreeze the prince's assets"}},{"uid":"EhrQZJNjCd79LLYq","external_uid":"partner-generated-id","source_synthetic_account_uid":"4XkJnsfHsuqrxmeX","destination_synthetic_account_uid":"exMDShw6yM3NHLYV","initiating_customer_uid":"iDtmSA52zRhgN4iy","destination_customer_uid":"iDtmSA52zRhgN4iy","status":"pending","initiator_type":"customer","created_at":"2019-10-14T03:21:53.301Z","transaction_uids":[],"ach":{"originator_name":"Mr. Hyyt Meiser","company_id":"HJK867","company_discretionary_data":"Some data","prenote":false,"sec_code":"CCD","payment_type":"S","entry_description":"ACH Entry","service_processing":"STANDARD","effective_entry_date":"2023-12-21","id_number":4270465600,"addenda":"Having said that, this"}}]}}}}}}}},"post":{"tags":["Transfers"],"summary":"Initiate a Transfer","description":"Attempt to initiate a Transfer between two Synthetic Accounts. Before the Transfer will be initiated, several checks will be performed to ensure there is sufficient balance in the source account and that the initiating Customer has all the necessary access to both Synthetic Accounts.\n\nThe Synthetic Accounts allowed in a Transfer request are listed below\n\n- between a liability Synthetic Account in the `general` category and a Synthetic Account in the `ach_external`, `wire_external`, or `instant_payments_external` category\n- between two liability Synthetic Accounts in the `general` category that are also owned by the same Customer.\n\n> **Note**\n> Please note that if utilizing the Transmitter information, the initiator type should be set to transmitter. If not set, the field defaults to customer and any data provided in that field will be ignored.","requestBody":{"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":{"external_uid":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/put/requestBody/content/application~1json/schema/properties/external_uid/allOf/1"}}}]},{"allOf":[{"type":"object","properties":{"source_synthetic_account_uid":{"type":"string","example":"4XkJnsfHsuqrxmeX","description":"Synthetic Account where the assets should be debited. Must be an active liability or external-type account. Cannot be equal to `destination_synthetic_account_uid`."},"destination_synthetic_account_uid":{"type":"string","example":"exMDShw6yM3NHLYV","description":"Synthetic Account where the assets should be credited. Must be an active liability or external-type account. Cannot be equal to `source_synthetic_account_uid`."},"initiating_customer_uid":{"type":"string","example":"iDtmSA52zRhgN4iy","description":"Customer that initiated the Transfer, when `initiator_type` is `customer`. The Customer and Synthetic Accounts supplied in the Transfer request must relate to the same Pool for the Transfer to be accepted."},"destination_customer_uid":{"type":"string","example":"iDtmSA52zRhgN4iy","description":"Customer who is on the receiving end of the Transfer. The destination Customer must be provided for peer to peer Transfers and can be optional for all other Transfers. If not provided, the destination Customer will be the same as the initiating Customer by default."},"status":{"type":"string","description":"A value indicating the overall status of the Transfer.\n","enum":["canceled","queued","pending","settled","failed"],"readOnly":true,"example":"pending"},"initiator_type":{"type":"string","description":"The initiator_type declares the originator for the Transfer. If set to Customer, origination information is pulled from the supplied initiating_customer_uid. If set to Transmitter, origination information is required, provided in the transmitter object (see below). Defaults to Customer. Providing Transmitter information is the Client's responsibility, please review more details in our [Transfers guide](https://developers.newline53.com/docs/transfer#introduction-what-is-a-transfer).\n","enum":["customer","transmitter"],"example":"customer"},"created_at":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp of when the transfer request was received","example":"2019-10-14T03:21:53.301Z"},"queued_until":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp indicating when the transfer is scheduled to be processed. Only applicable when the program is configured to queue on the relevant payment rail. When queuing is configured, the value is equal to the configured queuing minutes added to the transfer creation time.\n","example":"2019-10-14T03:31:53.301Z"}}}]},{"type":"object","properties":{"usd_transfer_amount":{"type":"string","description":"The USD amount to transfer","example":"12.34"},"ach":{"allOf":[{"type":"object"},{"description":"ACH information. Only present if the Transfer is an ACH.\n"},{"type":"object","properties":{"originator_name":{"type":"string","description":"Individual or business originating the ACH transfer. 1 to 16 characters; letters, numbers, apostrophe, comma, period, dash allowed.\n","pattern":"^[a-zA-Z0-9.,' -]{1,16}$","example":"J. Fred Muggs"},"company_id":{"type":"string","description":"ACH Company ID. 1 to 10 characters. Letters, numbers, apostrophe, comma, period, dash allowed. Optional for the majority of cases. Required if the general liability account is configured with multiple IDs. Whether optional or required, it will be validated if supplied.\n","pattern":"^[a-zA-Z0-9.,' -]{1,10}$","example":"ABC-123456"},"company_discretionary_data":{"type":"string","description":"An optional field to add customized information such as a customer code or internal reference number. 1 to 10 characters. Alphanumeric. Also allows '.', ',', or '-'.\n","pattern":"^[a-zA-Z0-9.,' -]{1,10}$","example":"ABC.123"},"prenote":{"type":"boolean","description":"If prenote is 'true', the amount of the transfer must be $0.00. Newline will infer credit_prenote or debit_prenote based on the source and destination accounts. If prenote is 'true', then the resulting Transaction Type of the resulting transaction record is of type: 'ach'. If no value is provided, the default value will be 'false'.\n","example":false},"sec_code":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/sec_code/allOf/0"},"payment_type":{"type":"string","description":"Recurring (R), single entry (S), or standing authorization entry (ST). If no value is provided, the default value populated in the NACHA file is for a single entry.\n","enum":["R","S","ST"],"example":"ST"},"entry_description":{"description":"Description value that will appear in the bank statement.\n","allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/entry_description/allOf/0"}]},"service_processing":{"type":"string","description":"Requested service processing duration for the ACH transfer. Allowable values are: STANDARD or SAMEDAY\n","enum":["SAMEDAY","STANDARD"],"example":"SAMEDAY"},"effective_entry_date":{"type":"string","description":"The effective date when the transaction is scheduled to be processed. Date values provided cannot be in the past or provided in the future beyond 30 days. For received returns, if the date provided by the originating financial institution does not match the Newline format, then the raw value will be returned. The Newline date format is YYYY-MM-DD\n","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2023-12-01"},"id_number":{"type":"string","description":"Unique identifier supplied by the originator of a transaction (e.g. invoice number). 1 to 22 characters depending on SEC code, alphanumeric. If the SEC value is anything other than CIE, then this is an optional field and can be up to 15 characters. If SEC value CIE is provided, then the ID number is mandatory, and the character length can be up to 22 characters.\n","pattern":"^[a-zA-Z0-9 ]{1,22}$","example":"4270465600"},"addenda":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/addenda/allOf/0"}},"required":["effective_entry_date","entry_description","originator_name","sec_code","service_processing"]}]},"instant_payment":{"type":"object","description":"Instant payment information. Only present if the Transfer is an instant payment.\n","properties":{"instant_payment_transmitter":{"allOf":[{"type":"object","description":"Address of the Transmitter. Must be provided if the `initiator_type` is `transmitter`.\n","properties":{"name":{"description":"Name of the Transmitter.\n","maxLength":140,"type":"string","example":"Marge's Roofing Inc","pattern":"[a-zA-Z0-9-_#|]{1,140}$"},"transmitter_identifier":{"description":"Up to 24 characters, and supplied by Transmitter. Alphanumeric only.","maxLength":24,"minLength":1,"type":"string","example":"123456789012ABC","pattern":"\\A[a-zA-Z0-9]+\\Z"}},"required":["name","transmitter_identifier"]},{"type":"object","properties":{"street_number":{"type":"string","description":"Building number for Transmitter address. Alphanumeric only.","maxLength":16,"pattern":"^[a-zA-Z0-9]{1,16}$","example":"123abc"},"street1":{"type":"string","description":"Street name for Transmitter address","maxLength":70,"pattern":"^[a-zA-Z0-9-. #/]{1,70}$","example":"Abc St."},"street2":{"type":"string","description":"Optional second line of street","maxLength":70,"pattern":"^[a-zA-Z0-9-. #/]{1,70}$","example":"Suite 4A"},"city":{"type":"string","description":"Maximum 35 characters","maxLength":35,"pattern":"^[a-zA-Z-. /]{1,35}$","nullable":true,"example":"Chicago"},"state":{"type":"string","description":"2 characters. Must be a valid US state abbreviation.","pattern":"^\\w{2}$","nullable":true,"example":"IL"},"postal_code":{"type":"string","description":"5-digit string. ZIP+4 is allowed.","pattern":"^\\d{5}(-\\d{4})?$","nullable":true,"example":"60301"},"country":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/0/properties/country"}},"required":["street_number","street1","city","state","postal_code","country"]}]},"memo":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/memo/allOf/0"}}},"wire":{"allOf":[{"type":"object"},{"description":"Wire-specific information. Only present if the Transfer is a wire.\n"},{"type":"object","properties":{"intermediary_bank_address":{"allOf":[{"description":"Address of the intermediary bank. To be populated if an intermediary bank is required to execute the wire transfer.\n"},{"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":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/intermediary_bank_name/allOf/0"},"intermediary_bank_routing_number":{"allOf":[{"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\n"},{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/intermediary_bank_routing_number/allOf/0"}]},"wire_instructions":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/wire_instructions/allOf/0"},"wire_transmitter":{"allOf":[{"type":"object","description":"Address of the Transmitter. Must be provided if the `initiator_type` is `transmitter`.\n","properties":{"name":{"description":"Name of the Transmitter.\n","maxLength":35,"type":"string","example":"Marge's Roofing Inc","pattern":"^[a-zA-Z0-9.,' -]{1,35}$"},"transmitter_identifier":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/instant_payment/properties/instant_payment_transmitter/allOf/0/properties/transmitter_identifier"}}},{"type":"object","properties":{"line1":{"type":"string","description":"Up to 35 characters. Cannot contain \\# @ $ ! ” % & * ; < > { } [ ] _ ^ \\ ~","pattern":"/^[^#@\\$!\"%&\\*;<>\\{\\}_\\^\\\\~\\]\\[]{1,35}$/","nullable":true,"example":"123 Abc St."},"line2":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/0/properties/line2"},"line3":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/0/properties/line3"},"country":{"allOf":[{"$ref":"#/paths/~1transfers/get/responses/200/content/application~1json/schema/allOf/1/properties/data/items/allOf/3/properties/instant_payment/properties/instant_payment_transmitter/allOf/1/properties/country/allOf/0"},{"nullable":false},{"example":"US"}]}}},{"required":["name","transmitter_identifier","line1","country"]}]}}}]}},"required":["destination_synthetic_account_uid","initiating_customer_uid","source_synthetic_account_uid","usd_transfer_amount"]}]},"examples":{"ach":{"value":{"external_uid":"partner-generated-id","initiating_customer_uid":"iDtmSA52zRhgN4iy","destination_customer_uid":"iDtmSA52zRhgN4iy","initiator_type":"customer","source_synthetic_account_uid":"4XkJnsfHsuqrxmeX","destination_synthetic_account_uid":"exMDShw6yM3NHLYV","usd_transfer_amount":"12.34","ach":{"originator_name":"Mr. Hyyt Meiser","company_id":"HJK867","company_discretionary_data":"Some data","prenote":false,"sec_code":"CCD","payment_type":"S","entry_description":"ACH Entry","service_processing":"STANDARD","effective_entry_date":"2023-12-21","id_number":4270465600,"addenda":"Having said that, this"}}},"instant_payment":{"value":{"external_uid":"partner-generated-id","initiating_customer_uid":"iDtmSA52zRhgN4iy","destination_customer_uid":"iDtmSA52zRhgN4iy","initiator_type":"customer","source_synthetic_account_uid":"4XkJnsfHsuqrxmeX","destination_synthetic_account_uid":"exMDShw6yM3NHLYV","usd_transfer_amount":"12.34","instant_payment":{"instant_payment_transmitter":{"name":"Royalty Asset Management","transmitter_identifier":"123456789","street_number":123,"street1":"Abc St.","city":"Boring","state":"OR","postal_code":97009},"memo":"To unfreeze the prince's assets"}}},"wire":{"value":{"external_uid":"partner-generated-id","initiating_customer_uid":"iDtmSA52zRhgN4iy","destination_customer_uid":"iDtmSA52zRhgN4iy","initiator_type":"customer","source_synthetic_account_uid":"4XkJnsfHsuqrxmeX","destination_synthetic_account_uid":"exMDShw6yM3NHLYV","usd_transfer_amount":"12.34","wire":{"intermediary_bank_address":{"line1":"345 Def Ave","line2":"San Francisco","line3":"CA 94016","country":"US"},"intermediary_bank_name":"Fidelity Fiduciary Bank","intermediary_bank_routing_number":"923456789","wire_transmitter":{"name":"Top Tier Tacos","transmitter_identifier":"123456789","street_number":123,"street1":"Abc St.","city":"Boring","state":"OR","postal_code":97009},"wire_instructions":"Please send ASAP"}}}}}}},"responses":{"201":{"description":"A new Transfer is initiated","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":{"external_uid":{"allOf":[{"description":"A unique identifier, optionally supplied by the Client when the Transfer was requested\n"},{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/put/requestBody/content/application~1json/schema/properties/external_uid/allOf/1"}]}}},{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/1"},{"type":"object","properties":{"transaction_uids":{"type":"array","description":"An array of Transaction UIDs that are associated with this Transfer.\n","example":["Ym4RSchXQmmr6KfK","vmxGSMb1vFLoyc1B"],"items":{"type":"string"}},"usd_transfer_amount":{"type":"string","description":"The USD amount to transfer\n","example":"34.12"},"ach":{"allOf":[{"type":"object"},{"description":"ACH information. Only present if the Transfer is an ACH.\n"},{"type":"object","properties":{"originator_name":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/ach/allOf/2/properties/originator_name"},"company_id":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/ach/allOf/2/properties/company_id"},"company_discretionary_data":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/ach/allOf/2/properties/company_discretionary_data"},"prenote":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/ach/allOf/2/properties/prenote"},"sec_code":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/sec_code/allOf/0"},"payment_type":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/ach/allOf/2/properties/payment_type"},"entry_description":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/ach/allOf/2/properties/entry_description"},"service_processing":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/ach/allOf/2/properties/service_processing"},"effective_entry_date":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/ach/allOf/2/properties/effective_entry_date"},"id_number":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/ach/allOf/2/properties/id_number"}}}]},"instant_payment":{"type":"object","description":"Instant payment information. Only present if the Transfer is an instant payment.\n","properties":{"instant_payment_transmitter":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/instant_payment/properties/instant_payment_transmitter"}}},"wire":{"allOf":[{"description":"Wire-specific information. Only present if the Transfer is a wire.\n"},{"$ref":"#/paths/~1transfers/post/responses/201/content/application~1json/schema/allOf/1/properties/wire/allOf/2"}]},"cancellation":{"type":"object","description":"Cancellation information. Only present if there has been an attempt at canceling the transfer.\n","properties":{"authorized_representative_name":{"type":"string","description":"Name of the authorized representative who wanted to cancel the transfer.","example":"Swee'Pea"},"cancellation_reason":{"type":"string","description":"Reason for cancellation.","example":"Transfer submitted by accident"},"current_cancellation_status":{"type":"string","enum":["pending_cancellation","successful_cancellation","failed_cancellation"]},"cancellation_requested_at":{"type":"string","format":"date-time","description":"The DateTime at which a cancellation request was most recently received.","example":"2024-02-06T22:25:28.013Z"},"cancellation_succeeded_at":{"type":"string","format":"date-time","description":"The DateTime at which a cancellation request succeeded. Only present if `current_cancellation_status` is `successful_cancellation`.\n","example":"2024-02-06T22:25:39.618Z"},"cancellation_failed_at":{"type":"string","format":"date-time","description":"The DateTime at which a cancellation request last failed. Only present if `current_cancellation_status` is `failed_cancellation`.\n","example":"2024-02-06T22:25:39.618Z"}}}}}]},{"type":"object","properties":{"ach":{"type":"object","description":"ACH information. Only present if the Transfer is an ACH.\n","allOf":[{"allOf":[{"$ref":"#/paths/~1transfers/post/responses/201/content/application~1json/schema/allOf/0/allOf/3/properties/ach/allOf/2"},{"type":"object","properties":{"transfer_trace_id":{"type":"string","description":"Trace ID to identify the transaction across Newline and Fifth Third Bank applications.","example":"A1Z2b3y4c5x6DW78"},"addenda":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/addenda/allOf/0"}}}]}],"example":null},"instant_payment":{"type":"object","description":"Instant payment information. Only present if the Transfer is an instant payment.\n","properties":{"memo":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/memo/allOf/0"}},"example":null},"wire":{"allOf":[{"type":"object"},{"description":"Wire-specific information. Only present if the Transfer is a wire.\n"},{"allOf":[{"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.\n","$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/wire/allOf/2/properties/intermediary_bank_address/allOf/1"}}},{"type":"object","properties":{"intermediary_bank_name":{"description":"Name of the intermediary bank, when applicable. For wires only. Maximum 35 characters.\n","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\n","$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/intermediary_bank_routing_number/allOf/0"}}}]},{"type":"object","properties":{"intermediary_bank_routing_number":{"allOf":[{"description":"The ABA routing number associated with the intermediary bank involved in the wire transfer\n"},{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/intermediary_bank_routing_number/allOf/0"}]},"wire_transmitter":{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema/allOf/2/properties/wire/allOf/2/properties/wire_transmitter"}}}]},{"type":"object","properties":{"wire_instructions":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/wire_instructions/allOf/0"}}}]}}}]},"examples":{"ach_transfer":{"value":{"uid":"EhrQZJNjCd79LLYq","external_uid":"partner-generated-id","source_synthetic_account_uid":"4XkJnsfHsuqrxmeX","destination_synthetic_account_uid":"exMDShw6yM3NHLYV","initiating_customer_uid":"iDtmSA52zRhgN4iy","destination_customer_uid":"iDtmSA52zRhgN4iy","status":"pending","initiator_type":"customer","created_at":"2019-10-14T03:21:53.301Z","transaction_uids":[],"ach":{"originator_name":"Mr. Hyyt Meiser","company_id":"HJK867","company_discretionary_data":"Some data","prenote":false,"sec_code":"CCD","payment_type":"S","entry_description":"ACH Entry","service_processing":"STANDARD","effective_entry_date":"2023-12-21","id_number":4270465600,"addenda":"Having said that, this"}}},"instant_payment_transfer":{"value":{"uid":"VeYqeb1iHqBR4LEi","external_uid":"partner-created-id","source_synthetic_account_uid":"ABv3vs5yVypxpGgF","destination_synthetic_account_uid":"RRbw63TF4o1vg2RQ","initiating_customer_uid":"oBugADTMCMEU4sfE","destination_customer_uid":"22PBwMT88qCQWMSg","status":"settled","initiator_type":"transmitter","created_at":"2019-10-14T03:21:53.301Z","transaction_uids":["d8WUMmm4dZfMpLeh"],"usd_transfer_amount":32.13,"instant_payment":{"instant_payment_transmitter":{"name":"Royalty Asset Management","transmitter_identifier":"123456789","street_number":123,"street1":"Abc St.","city":"Boring","state":"OR","postal_code":97009},"memo":"To unfreeze the prince's assets"}}},"wire_transfer":{"value":{"uid":"EhrQZJNjCd79LLYq","external_uid":"partner-generated-id","source_synthetic_account_uid":"4XkJnsfHsuqrxmeX","destination_synthetic_account_uid":"exMDShw6yM3NHLYV","initiating_customer_uid":"iDtmSA52zRhgN4iy","destination_customer_uid":"iDtmSA52zRhgN4iy","status":"pending","initiator_type":"transmitter","created_at":"2019-10-14T03:21:53.301Z","transaction_uids":[],"usd_transfer_amount":33.12,"wire":{"intermediary_bank_address":{"line1":"345 Def Ave","line2":"San Francisco","line3":"CA 94016","country":"US"},"intermediary_bank_name":"Fidelity Fiduciary Bank","intermediary_bank_routing_number":"923456789","wire_transmitter":{"name":"Top Tier Tacos","transmitter_identifier":"123456789","street_number":123,"street1":"Abc St.","city":"Boring","state":"OR","postal_code":97009},"wire_instructions":"Please send ASAP"}}}}}}}}}},"/transfers/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Transfers"],"summary":"Get a single Transfer","description":"Retrieves a single Transfer resource along with its details, including status, participating accounts, and associated Transactions.\n\nFilter parameters are not case sensitive but will only return exact matches.","responses":{"200":{"description":"A single Transfer is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1transfers/post/responses/201/content/application~1json/schema"},"examples":{"ach_transfer":{"$ref":"#/paths/~1transfers/post/responses/201/content/application~1json/examples/ach_transfer"},"instant_payment_transfer":{"$ref":"#/paths/~1transfers/post/responses/201/content/application~1json/examples/instant_payment_transfer"},"wire_transfer":{"$ref":"#/paths/~1transfers/post/responses/201/content/application~1json/examples/wire_transfer"},"canceled_transfer":{"value":{"uid":"EhrQZJNjCd79LLYq","external_uid":"partner-generated-id","source_synthetic_account_uid":"4XkJnsfHsuqrxmeX","destination_synthetic_account_uid":"exMDShw6yM3NHLYV","initiating_customer_uid":"iDtmSA52zRhgN4iy","destination_customer_uid":"iDtmSA52zRhgN4iy","status":"canceled","initiator_type":"customer","created_at":"2019-10-14T03:21:53.301Z","transaction_uids":[],"usd_transfer_amount":33.12,"wire":{"intermediary_bank_address":{"line1":"345 Def Ave","line2":"San Francisco","line3":"CA 94016","country":"US"},"intermediary_bank_name":"Fidelity Fiduciary Bank","intermediary_bank_routing_number":"923456789","wire_instructions":"Please send ASAP","wire_transmitter":null},"cancellation":{"authorized_representative_name":"Swee'Pea","cancellation_reason":"Transfer submitted by accident","current_cancellation_status":"successful_cancellation","cancellation_requested_at":"2019-10-14T03:29:31.230Z","cancellation_succeeded_at":"2019-10-14T03:29:35.806Z","cancellation_failed_at":null}}}}}}}}}},"/transfers/{uid}/cancel":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"put":{"tags":["Transfers"],"summary":"Cancel a Transfer","description":"Transfers must be canceled by the originating Customer (or Authorized Representative).\n\nTransfers can only enter the canceled state if Newline receives a request while the Transfer is in `queued` or `pending states`.\n\nA cancellation request during the `pending` state is not guaranteed, as this state may include payment execution. At that stage, a cancel request will result in an error.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"authorized_representative_name":{"type":"string","description":"Name of the authorized representative who wants to cancel the transfer. Max 35 characters.\n","maxLength":35,"example":"Swee'Pea"},"cancellation_reason":{"type":"string","description":"Reason for cancellation. Max 135 characters.\n","maxLength":135,"example":"Transfer submitted by accident"}}}}}},"responses":{"200":{"description":"The updated Transfer resource is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1transfers/post/responses/201/content/application~1json/schema"},"examples":{"canceled_transfer":{"$ref":"#/paths/~1transfers~1%7Buid%7D/get/responses/200/content/application~1json/examples/canceled_transfer"}}}}},"400":{"description":"The transfer is not eligible for cancellation","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":{"invalid_transfer_cancellation":{"value":{"errors":[{"code":3025,"title":"Transfer cannot be canceled","detail":"Newline cannot cancel the transfer submitted. Please verify the transfer UIDs, the type of transfer (wire or ACH), and the status of the transfer being canceled.","occurred_at":"2024-03-06T14:53:45.084Z","extra":"Transfer status must be one of the following to cancel: pending, queued"}],"status":400}}}}}},"422":{"description":"The transfer could not be canceled","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":{"transfer_cancellation_error":{"value":{"errors":[{"code":3026,"title":"Could not cancel transfer","detail":"An exception occurred while canceling the transfer","occurred_at":"2024-03-06T14:15:55.723Z","extra":"The payment has already been submitted. It is too late to cancel."}],"status":422}}}}}}}}},"/sandbox/mock_transactions":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"post":{"tags":["Sandbox"],"summary":"Simulate a Transaction","description":"> **Note** This endpoint is only available in Sandbox.\n\nCreate a Transaction by simulating the attributes that would be expected from reading an actual transaction received from a third party system. The simulated Transaction will appear in the respective [Transaction list](https://developers.newline53.com/reference/get_transactions) after it is successfully processed.\n\nTransactions can be simulated against either a Synthetic Account, or a VRN that is created and mapped to a Synthetic Account.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"customer_uid":{"type":"string","example":"uKxmLxUEiSj5h4M3","description":"The uid of the customer for which to create the Transaction. Required except when `transaction_type` is `ach_return`.\n"},"transaction_type":{"type":"string","enum":["wire","instant_payment","ach","ach_return"]},"transaction_uid":{"type":"string","example":"6DZvpWma5vLsfCcN","description":"The Transaction UID value is required when the simulated transaction type is \"ach_return\". This is the transaction that newline will simulate the return for. The transaction supplied must be of type 'ACH'.\n"},"us_dollar_amount":{"type":"number","description":"Positive value interpreted as a `credit`;\nnegative value interpreted as a `debit`.\nRequired for `transaction_type` of `wire`, `instant_payment`, and `ach`;\nignored when `transaction_type` is `ach_return`.","example":21.89},"description":{"type":"string","minLength":8,"description":"Additional information about this Mock Transaction; used as the Transaction description. When provided, a minimum of 8 characters is required.\n"},"synthetic_account_uid":{"type":"string","example":"4XkJnsfHsuqrxmeX","description":"Optionally specifies the general Synthetic Account to be used for creating the transaction. If not passed, a random Synthetic Account belonging to the Customer will be used."},"virtual_reference_number_uid":{"type":"string","example":"tpowGE5fhRKVX3ge","description":"Optional. If a VRN UID is supplied the simulated transaction will be associated with that VRN. The VRN UID must be in an active status. Only the following simulated transactions can have an associated VRN: wire credits, ACHs, or instant_payment."},"network":{"type":"string","enum":["tch","fednow"],"example":"fednow","description":"Optional. You may specify the network on which to simulate the transaction. If not specified, the default network `\"tch\"` will be used. Applicable for `transaction_type` of `instant_payment`.\n"},"counterparty_address":{"description":"Address of the business or individual who owns the external account. Applicable for `transaction_type` of `wire` or `instant_payment`.\n","oneOf":[{"type":"object","properties":{"line1":{"type":"string","description":"Optional 35 characters. Cannot contain \\# @ $ ! ” % & * ; < > { } [ ] _ ^ \\ ~\n","pattern":"/^[^#@\\$!\"%&\\*;<>\\{\\}_\\^\\\\~\\]\\[]{0,35}$/","nullable":true,"example":"123 Abc St."},"line2":{"type":"string","description":"Optional 35 characters. Cannot contain \\# @ $ ! ” % & * ; < > { } [ ] _ ^ \\ ~\n","pattern":"/^[^#@\\$!\"%&\\*;<>\\{\\}_\\^\\\\~\\]\\[]{0,35}$/","nullable":true,"example":"Boring, Oregon 97009"},"line3":{"type":"string","description":"Optional 32 characters. Note that this length is shorter than the other lines. Cannot contain \\# @ $ ! ” % & * ; < > { } [ ] _ ^ \\ ~\n","pattern":"/^[^#@\\$!\"%&\\*;<>\\{\\}_\\^\\\\~\\]\\[]{0,32}$/","nullable":true,"example":null},"country":{"allOf":[{"type":"string","description":"2 character ISO 3166 country code: https://www.iso.org/iso-3166-country-codes.html\n","maxLength":2,"minLength":2},{"nullable":true},{"example":null}]}}},{"type":"object","properties":{"street_number":{"type":"string","description":"Building number for counterparty address. Alphanumeric only.","maxLength":16,"pattern":"^[a-zA-Z0-9]{1,16}$","example":"123abc"},"street1":{"type":"string","description":"Street name for counterparty address","maxLength":70,"minLength":3,"pattern":"^[a-zA-Z0-9-. #/]{3,70}$","example":"Abc St."},"street2":{"type":"string","description":"Optional second line of street","maxLength":70,"pattern":"^[a-zA-Z0-9-. #/]{1,70}$","example":"Suite 4A"},"city":{"type":"string","description":"Maximum 35 characters","maxLength":35,"pattern":"^[a-zA-Z-. /]{1,35}$","nullable":true,"example":"Chicago"},"state":{"type":"string","description":"2 characters. Must be a valid US state abbreviation.","pattern":"^\\w{2}$","nullable":true,"example":"IL"},"postal_code":{"type":"string","description":"5-digit string. ZIP+4 is allowed.","pattern":"^\\d{5}(-\\d{4})?$","nullable":true,"example":"60301"},"country":{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/0/properties/country"}},"required":["street_number","street1","city","state","postal_code","country"]}]},"counterparty_name":{"description":"Name of the business or individual who owns the external account. Maximum 35 characters. Applicable for `transaction_type` of `wire` or `instant_payment`.\n","allOf":[{"maxLength":35,"type":"string","example":"Marge's Roofing Inc"}]},"counterparty_bank_address":{"description":"Address of the financial institution where the external account is held. Applicable for `transaction_type` of `wire`.\n","allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_address/oneOf/0"}]},"counterparty_bank_name":{"description":"Name of the financial institution where the counterparty account is held. Maximum 35 characters. Applicable for `transaction_type` of `wire`.\n","allOf":[{"maxLength":35,"type":"string","example":"East West Regional Bank"}]},"entry_description":{"description":"Description of the transaction. Applicable for `transaction_type` of `ach`.\n","allOf":[{"type":"string","minLength":1,"maxLength":10,"pattern":"^[a-zA-Z0-9 ]{1,10}$","example":"ACH Entry"}]},"intermediary_bank_address":{"description":"Address of the intermediary bank, when applicable. Applicable for `transaction_type` of `wire`.\n","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. Maximum 35 characters. Applicable for `transaction_type` of `wire`.\n","allOf":[{"maxLength":35,"type":"string","example":"Fidelity Fiduciary Bank"}]},"intermediary_bank_routing_number":{"description":"The routing number associated with the intermediary bank involved in the wire transfer. Applicable for `transaction_type` of `wire`.\n","allOf":[{"example":"923456789","allOf":[{"$ref":"#/paths/~1virtual_reference_numbers/post/requestBody/content/application~1json/schema/properties/routing_number/allOf/0"}]}]},"memo":{"description":"A message transmitted to the recipient. Applicable for `transaction_type` of `instant_payment`.\n","allOf":[{"description":"A message transmitted to the recipient bank. Can contain letters and numbers as well as '-', '_', and spaces.\n","allOf":[{"type":"string","nullable":true,"example":"For the 6-5-23 shipment of pineapple popsicles","maxLength":140,"pattern":"/\\A[a-zA-Z0-9\\-_ ]{0,140}\\Z/"}]}]},"wire_instructions":{"description":"Instructions for the recipient of the wire. Maximum 140 characters. Applicable for `transaction_type` of `wire`.\n","allOf":[{"description":"Additional details or instructions for the wire, issued to the recipient financial institution when the wire is executed.\n","allOf":[{"type":"string","maxLength":140,"example":"Send ASAP"}]}]},"addenda":{"allOf":[{"type":"string","description":"Optional additional payment-related information, such as invoice numbers, originator/receiver information, payment instructions, etc. Up to 80 characters. Optional for all newline supported SEC codes other than TEL. Newline will reject the Transfer if an Addenda value is provided with SEC code TEL.\n","maxLength":80,"pattern":"^.{1,80}$"}]},"sec_code":{"allOf":[{"type":"string","description":"Standard Entry Class (SEC) code. Newline supports the following SEC codes: CCD, CIE, PPD, TEL, WEB. For more details, refer to our ACH guide's [section](https://developers.newline53.com/docs/ach#standard-entry-class-sec-codes) on SEC code use.\n","enum":["CCD","CIE","PPD","TEL","WEB"],"example":"CIE"}]},"iat":{"type":"string","example":"enabled","nullable":true,"description":"Optional. If the `iat` param is supplied on a mocked RDFI or ODFI ACH transaction, the transaction will have IAT details mocked accordingly."}}},{"type":"object","properties":{"chips":{"type":"string","nullable":true,"description":"CHIPS number of the wire recipient. At most one of `chips`, `imad`, or `uetr` should be present.\n"},"imad":{"type":"string","nullable":true,"description":"FedWire IMAD number identifying a wire transaction. At most one of `chips`, `imad`, or `uetr` should be present.\n","example":"20220123ABCDEFGH123456"},"uetr":{"type":"string","nullable":true,"description":"Unique End to end Transaction Reference value from SWIFT for a wire transaction. At most one of `chips`, `imad`, or `uetr` should be present.\n"}}}],"required":["transaction_type"]},"examples":{"wire_mock_transaction_minimal":{"value":{"customer_uid":"kaxHFJnWvJxRJZxq","transaction_type":"wire","us_dollar_amount":21.89}},"wire_mock_transaction":{"value":{"customer_uid":"kaxHFJnWvJxRJZxq","transaction_type":"wire","us_dollar_amount":21.89,"counterparty_address":{"line1":"123 Abc Ave","line2":"San Francisco","line3":"CA 94016","country":"US"},"counterparty_name":"Judith's Woodworks LLP","counterparty_bank_address":{"line1":"345 Def Ave","line2":"San Francisco","line3":"CA 94016","country":"US"},"counterparty_bank_name":"Bank of Americana","imad":"20220123ABCDEFGH123456","synthetic_account_uid":"4XkJnsfHsuqrxmeX","wire_instructions":"shipment #424 cedar owl dioramas","virtual_reference_number_uid":"tpowGE5fhRKVX3ge"}},"instant_payment_mock_transaction_minimal":{"value":{"customer_uid":"kaxHFJnWvJxRJZxq","transaction_type":"instant_payment","us_dollar_amount":21.89}},"instant_payment_mock_transaction":{"value":{"customer_uid":"kaxHFJnWvJxRJZxq","counterparty_address":{"line1":"123 Abc Ave","line2":"San Francisco","line3":"CA 94016","country":"US"},"counterparty_name":"Boryslav's Baking Co","description":"Instant payments mock transaction","memo":"weekly pumpernickel","transaction_type":"instant_payment","us_dollar_amount":21.89,"virtual_reference_number_uid":"tpowGE5fhRKVX3ge"}},"ach_mock_transaction":{"value":{"customer_uid":"kaxHFJnWvJxRJZxq","transaction_type":"ach","us_dollar_amount":21.89,"synthetic_account_uid":"4XkJnsfHsuqrxmeX","sec_code":"CCD","virtual_reference_number_uid":"tpowGE5fhRKVX3ge"}},"ach_return_mock_transaction":{"value":{"transaction_type":"ach_return","transaction_uid":"6DZvpWma5vLsfCcN"}}}}}},"responses":{"201":{"description":"A success message is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"string","example":"A mocked transaction has been successfully initiated."},"uid":{"type":"string","description":"The UID of the newly mocked Transaction.\n","example":"mDBBkGGG4wJzg3QV"}}}}}}}}},"/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`.\n"},{"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`.\n"},{"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`.\n"},{"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`.\n"},{"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.\n"},{"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.\n"},{"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.\n"},{"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`.\n"},{"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.\n"},{"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.\n"},{"$ref":"#/paths/~1pools/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/2"},{"name":"sort","in":"query","schema":{"type":"string","enum":["created_at_asc","created_at_desc","description_asc","description_desc","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\n"},{"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\n"},{"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\n"},{"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\n"},{"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\n"},{"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\n"},{"name":"settled_index_after","in":"query","schema":{"type":"integer","example":123},"description":"Return only transactions with `settled_index` after the provided value\n"},{"name":"settled_index_before","in":"query","schema":{"type":"integer","example":123},"description":"Return only transactions with `settled_index` before the provided value\n"},{"name":"id_after","in":"query","schema":{"type":"integer","example":123},"description":"Return only transactions with `id` after the provided value\n"},{"name":"id_before","in":"query","schema":{"type":"integer","example":123},"description":"Return only transactions with `id` before the provided value\n"}],"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.\n","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.\n","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.\n","allOf":[{"allOf":[{"$ref":"#/paths/~1transfers/post/responses/201/content/application~1json/schema/allOf/0/allOf/3/properties/ach/allOf/2"},{"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":{"$ref":"#/paths/~1transactions~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/ach/allOf/0/allOf/1/properties/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","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"}}},{"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.\n","example":233},"adjustment_uid":{"type":"string","description":"The UID of the Adjustment this Transaction is associated with, if any.","nullable":true,"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.\n","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.\n","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`\n","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.\n"},"return_uid":{"type":"string","description":"The uid of a related Return, when applicable.\n","nullable":true,"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","description":"Another unique index that indicates the order in which the Transactions were settled. Null if the Transaction's status is queued or pending.\n","example":23,"nullable":true},"source_synthetic_account_uid":{"type":"string","example":"4XkJnsfHsuqrxmeX","description":"Synthetic Account from where the asset is pulled"},"statement_posted_at":{"type":"string","format":"date-time","description":"The date and time when the statement was posted","example":"2019-10-17T00:01:53.682Z","nullable":true},"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`.\n\nOnce 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.\n"},"transaction_batch_uid":{"type":"string","example":"4","description":"The unique id of the Transaction Batch this Transaction is associated with, if any.","nullable":true},"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.\n","items":{"type":"string","example":["MB2yqBrm3c4bUbou","qCEEyGQw73Ajn3WZ"]}},"transfer_uid":{"type":"string","description":"The unique id of the Transfer this Transaction is associated with, if any.","nullable":true,"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.\n"},"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).\n"},"virtual_reference_number_uid":{"type":"string","example":null,"description":"The VRN uid, when the transaction was processed using a VRN.\n"}}}]},{"type":"object","properties":{"instant_payment":{"description":"Instant payment information. Only present if the Transaction is an instant payment.\n","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.\n","example":"ca5690da-f0f4-4ca1-acb0-1edb1ae41bd3"},"network":{"type":"string","description":"The network on which the instant payment was executed\n","example":"fednow"},"failure_code":{"type":"string","description":"A code indicating failure reason. It will only appear if transaction status is `failed`\n","example":"ERR100"},"failure_reason":{"type":"string","description":"A description of why the transaction failed. It will only appear if transaction status is `failed`\n","example":"Account number invalid or missing"},"counterparty_name":{"type":"string","description":"Name of the business or individual who owns the counterparty Account.\n","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.\n"},"counterparty_bank_routing_number":{"description":"The routing number associated with the counterparty bank account.\n","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\n","example":"3345"},"payment_id":{"type":"string","description":"An originator-defined value. For RTP transactions, this will be the End-to-End ID.\n","example":"BayleeStacy"},"transmitter_name":{"type":"string","description":"Name of the Transmitter.\n","example":"Marge's Roofing Inc"},"counterparty_bank_address":{"description":"Address of the financial institution where the external account is held.\n","nullable":true,"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.\n","nullable":true,"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.\n","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"counterparty_address":{"nullable":true,"description":"Address of the business or individual who owns the external account.\n","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.\n","allOf":[{"$ref":"#/paths/~1sandbox~1mock_transactions/post/requestBody/content/application~1json/schema/allOf/0/properties/counterparty_name/allOf/0"}]},"counterparty_bank_address":{"nullable":true,"description":"Address of the financial institution where the external account is held.\n","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":{"nullable":true,"description":"Name of the financial institution where the counterparty account is held.\n","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.\n","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.\n","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.\n","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\n","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.\n","type":"string","nullable":true,"example":"/DAS/REF:55555ZZ000ZZ"},"originator_account_number_last_four":{"description":"Last four digits of originator account number.\n","nullable":true,"type":"string","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.\n","allOf":[{"allOf":[{"$ref":"#/paths/~1transfers/post/responses/201/content/application~1json/schema/allOf/0/allOf/3/properties/ach/allOf/2"},{"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).\n"},"noc_corrected_data":{"type":"string","description":"Notification of Change (NOC) corrected data description, returned from the RDFI (Receiving Depository Financial Institution).\n"},"noc_reason":{"type":"string","description":"Notification of Change (NOC) description, returned from the RDFI (Receiving Depository Financial Institution).\n"},"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.\n","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.\nThe Newline API supports the following values:\n\n- `FF` - Fixed to Fixed\n- `FV` - Fixed to Variable\n","example":"FF"},"foreign_exchange_reference_indicator":{"type":"string","description":"Defines the type of value in the \"foreign_exchange_reference\" field.\nThe Newline API supports the following values:\n\n- `\"1\"` - Foreign Exchange Rate\n- `\"2\"` - Foreign Exchange Reference Number\n- `\"3\"` - If Foreign Exchange Indicator is \"FF\"\n","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.\nPayment transaction code requirements differ based on the receiving country.\n","example":"22"},"transaction_type_code":{"type":"string","description":"Identifies the IAT Transaction Type Code.\nThe Newline API supports the following values:\n\n- `\"ANN\"` (Annuity)\n- `\"RLS\"` (Rent/Lease)\n- `\"POS\"` (Point of Sale Entry)\n- `\"BUS\"` (Business/Commercial)\n- `\"SAL\"` (Salary/Payroll)\n- `\"RCK\"` (Re-presented Check Entry)\n- `\"DEP\"` (Deposit)\n- `\"TAX\"` (Tax)\n- `\"SHR\"` (Shared Network Transaction)\n- `\"LOA\"` (Loan)\n- `\"TEL\"` (Telephone-Initiated Entry)\n- `\"MIS\"` (Miscellaneous)\n- `\"ARC\"` (Accounts Receivable Entry)\n- `\"WEB\"` (Internet-Initiated Entry)\n- `\"MOR\"` (Mortgage)\n- `\"BOC\"` (Back Office Conversion Entry)\n- `\"PEN\"` (Pension)\n- `\"MTE\"` (Machine Transfer Entry)\n- `\"REM\"` (Remittance)\n- `\"POP\"` (Point of Purchase Entry)\n","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":"This field contains 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":"This field contains 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":"This field contains 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":"This field contains the name of the ODFI.","example":"BANK OF AMERICA NA"},"odfi_identification_number_qualifier":{"type":"string","description":"This field contains a 2-digit code that identifies the type of ID in the \"odfi_id\" field.\nThe Newline API supports the following values:\n\n- `\"01\"` - National Clearing System Number\n- `\"02\"` - BIC Code\n- `\"03\"` - IBAN\n","example":"01"},"odfi_id":{"type":"string","description":"This field contains 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":"This field contains the name of the RDFI.","example":"FIFTH THIRD BANK NATIONAL ASSOCIA"},"rdfi_identification_number_qualifier":{"type":"string","description":"This field contains a 2-digit code that identifies the type of ID in the \"rdfi_id\" field.\nThe Newline API supports the following values:\n\n- `\"01\"` - National Clearing System Number\n- `\"02\"` - BIC Code\n- `\"03\"` - IBAN\n","example":"01"},"rdfi_id":{"type":"string","description":"This field contains 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":"This field contains the street address of the Receiver.","example":"228 S BURNS"},"counterparty_city_state_province":{"type":"string","description":"This field contains 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":"This field contains 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":"This field contains payment related information. \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":"This field contains payment related information. \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":"This field identifies the name of the Foreign Correspondent Bank when provided","example":"BANK OF AMERICA CANADA"},"id_number_qualifier":{"type":"string","description":"This field contains a 2-digit code that identifies the type of ID in the \"id_number\" field when provided.\nThe Newline API supports the following values:\n\n- `\"01\"` - National Clearing System Number\n- `\"02\"` - BIC Code\n- `\"03\"` - IBAN\n","example":"01"},"id_number":{"type":"string","description":"This field contains the bank identification number of the Foreign Correspondent Bank when provided","example":"121000358"},"branch_country_code":{"type":"string","description":"This field contains 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","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"}}}},"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":{"content":{"application/json":{"schema":{"properties":{"authorization_status":{"type":"string","description":"The current status of the transaction authorization.\n","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.\n"},"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`)\n","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.\n","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`.\n","example":"2024-10-9T00: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.\n","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.\n","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`.\n","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`.\n","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`.\n"}},{"name":"destination_custodial_account_uid","in":"query","schema":{"type":"string","example":"W55zKgvAk3zkpGM3","description":"Filter by destination Custodial Account. Multiple values are allowed, e.g. `destination_custodial_account_uid[]=W55zKgvAk3zkpGM3&destination_custodial_account_uid[]=66gso857LyQWC6XN`.\n"}},{"name":"custodial_account_uid","in":"query","schema":{"type":"string","example":"dmRtw1xkS9ghrntB","description":"Filter by Custodial Account, source or destination. Multiple values are allowed, e.g. `custodial_account_uid[]=dmRtw1xkS9ghrntB&custodial_account_uid[]=W55zKgvAk3zkpGM3`.\n"}},{"name":"type","in":"query","schema":{"type":"string","enum":["odfi_ach_deposit","odfi_ach_withdrawal","rdfi_ach_deposit","rdfi_ach_withdrawal"],"example":"odfi_ach_deposit","description":"Filter by type. Multiple values are allowed, e.g. `type[]=odfi_ach_deposit&type[]=odfi_ach_withdrawal`.\n"}},{"name":"transaction_uid","in":"query","schema":{"type":"string","example":"SMwKC1osz77DTEiu"},"description":"Filter by Transaction. Multiple values are allowed, e.g. `transaction_uid[]=SMwKC1osz77DTEiu&transaction_uid[]=f1UDvUVNnXTKtgxu`.\n"},{"$ref":"#/paths/~1pools/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/2"},{"name":"sort","in":"query","schema":{"type":"string","enum":["created_at_asc","created_at_desc","description_asc","description_desc","settled_index_asc","settled_index_desc","us_dollar_amount_asc","us_dollar_amount_desc"]}}],"responses":{"200":{"description":"A list of Transaction Events is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1pools/get/responses/200/content/application~1json/schema/allOf/0"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/paths/~1transaction_events~1%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\n","example":9},"transaction_uids":{"type":"array","description":"A list of UIDS referring to Transactions this Transaction Event belongs to.\n","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`.\n","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.\n"},"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`.\n"},"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.\n","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`.\n"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created_at_asc","created_at_desc","description_asc","description_desc","settled_index_asc","settled_index_desc","us_dollar_amount_asc","us_dollar_amount_desc"]}}],"responses":{"200":{"description":"A list of Synthetic Line Items is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1pools/get/responses/200/content/application~1json/schema/allOf/0"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/paths/~1synthetic_line_items~1%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\n","example":9},"transaction_uid":{"type":"string","example":"SMwKC1osz77DTEiu","description":"UID of the Transaction this Synthetic Line Item belongs to"},"synthetic_account_uid":{"type":"string","example":"Jy8degj6iv2QngLo","description":"UID of the Synthetic Account this Synthetic Line Item is associated with"},"status":{"type":"string","enum":["settled"],"description":"Other statuses such as `pending` will be available later"},"us_dollar_amount":{"type":"string","description":"The signed USD amount of this specific Synthetic Line Item","example":"12.34"},"running_us_dollar_balance":{"type":"string","description":"The running balance after settlement for this specific Asset Type held within the Synthetic Account, expressed in US Dollars calculated using the asset price used for settlement.\n","example":"42.98"},"running_asset_balance":{"type":"string","description":"The running balance after settlement for this specific Asset Type held within the Synthetic Account, expressed in units of the given asset type.\n","example":"0.24"},"asset_quantity":{"type":"string","description":"The quantity of the specific asset type for this Synthetic Line Item","example":"21.31"},"asset_type":{"type":"string","description":"The type of asset for this Synthetic Line Item","example":"USD"},"closing_price":{"type":"string","description":"If this Synthetic Line Item involves a security purchase/sale the USD value at the time of the purchase/sale\n","example":"25.00"},"custodial_account_name":{"type":"string","description":"The name of the Custodial Account associated with this Synthetic Line Item","example":"Main Checking"},"custodial_account_uid":{"type":"string","description":"The UID of the Custodial Account associated with this Synthetic Line Item","example":"AM8Ai6JtuoE3Jgfr"},"description":{"type":"string","description":"Human-readable description in context of Synthetic Accounts","example":"Transfer from Synthetic Account 1 to Synthetic Account 2"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the Synthetic Line Item is first recognized by Newline. This may be when the Transfer is initiated if the Synthetic Line Item is associated with one.\n","example":"2019-10-15T15:53:13.591Z"},"settled_at":{"type":"string","format":"date-time","description":"The date and time when the Synthetic Line Item is settled","example":"2019-10-16T12:51:12.673Z"}}}]},"examples":{"syntheticLineItem":{"value":{"uid":"j56aHgLBqkNu1KwK","settled_index":10,"transaction_uid":"YBHNH3BgykqrjLgz","synthetic_account_uid":"exMDShw6yM3NHLYV","status":"settled","us_dollar_amount":"-12.34","running_us_dollar_balance":"4.21","running_asset_balance":"4.21","asset_quantity":"-12.34","asset_type":"USD","closing_price":"12.50","custodial_account_uid":"WPsSKYyKy9v4RQ6P","custodial_account_name":"Checking Account","description":"Debit to \"deposit architect hack\"","created_at":"2019-10-14T03:21:53.301Z","settled_at":"2019-10-17T00:01:53.682Z"}}}}}}}}},"/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`.\n"}},{"name":"status","in":"query","schema":{"type":"string","enum":["settled","voided"]},"description":"Filter by status. Multiple values are allowed, e.g. `status[]=pending&status[]=settled`.\n"},{"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.\n"},{"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.\n"},{"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`.\n"},{"$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\n","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.\n"},"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","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`.\n","nullable":true,"example":"34.21"},"running_asset_balance":{"type":"string","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`.\n","nullable":true,"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\n","example":"25.00"},"type":{"type":"string","description":"Symbols and/or numbers that represent different types of Custodial Line Items.\n","example":"transaction category 8348"},"description":{"type":"string","description":"Descriptions pulled from the custodians, such as through NACHA description or ISO-8583 data element 43\n","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.\n","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"}}}}}}}}},"/virtual_reference_numbers":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Virtual Reference Numbers"],"summary":"List Virtual Reference Numbers","description":"Retrieves a list of Virtual Reference Numbers (VRNs) associated with the specified Synthetic Account. Supports filtering by status and other attributes.\n","parameters":[{"name":"instant_payment_rail_registration_status","in":"query","schema":{"type":"string","description":"Registration status with Newline and Fifth Third, for RTP network acceptance.","example":"registered","enum":["failed","pending","registered","unregistered"]}},{"name":"status","in":"query","schema":{"description":"A value indicating the overall state of this VRN.","type":"string","example":"active","enum":["active","archived"]}},{"name":"synthetic_account_uid","in":"query","schema":{"type":"string","description":"A unique id referring to the mapped, general Synthetic Account.","example":"Dg1EPao8XukUpHG8"}},{"name":"virtual_reference_number","in":"query","schema":{"type":"string","description":"The VRN","example":"1234567890123456"}}],"responses":{"200":{"description":"A list of Virtual Reference Numbers 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/~1pools~1%7Buid%7D/get/responses/200/content/application~1json/schema/allOf/0"},{"$ref":"#/paths/~1virtual_reference_numbers/post/responses/201/content/application~1json/schema/allOf/0"}]}}}}]},"examples":{"virtual_reference_numbers_list":{"value":{"total_count":4,"count":2,"limit":2,"offset":0,"data":[{"archived_at":null,"created_at":"2023-10-04T13:23:04.345Z","custodial_account_uid":"tcvYpQ1ip76LaL4a","external_uid":null,"name":"greenfield1","routing_number":"123456789","instant_payment_rail_registration_status":"registered","locked_at":"2023-10-15T15:53:13.591Z","lock_reason":"customer_request","status":"active","synthetic_account_uid":"Dg1EPao8XukUpHG8","uid":"dYTG8WAWAh5UyvY7","virtual_reference_number_last_four":3456},{"archived_at":"2023-10-15T15:53:13.591Z","created_at":"2023-10-04T13:23:04.345Z","custodial_account_uid":"tcvYpQ1ip76LaL4a","external_uid\"":"abcdefg1","name":"greenfield2","routing_number":"123456789","instant_payment_rail_registration_status":"registered","locked_at":null,"lock_reason":null,"status":"archived","synthetic_account_uid":"Dg1EPao8XukUpHG8","uid":"dYTG8WAWAh5UyvY7","virtual_reference_number_last_four":4321}]}}}}}},"422":{"description":"Failed to retrieve Virtual Reference Numbers","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":{"failed_to_retrieve_vrns":{"value":{"errors":[{"code":30003,"title":"Failed to retrieve VRNs","detail":"An exception occurred while retrieving VRNs","occurred_at":"2023-10-04T13:23:04.345Z"}],"status":422}}}}}}}},"post":{"tags":["Virtual Reference Numbers"],"summary":"Create a new Virtual Reference Number","description":"Creates a new Virtual Reference Number (VRN) for the specified Synthetic Account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"external_uid":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/put/requestBody/content/application~1json/schema/properties/external_uid"},"name":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/put/requestBody/content/application~1json/schema/properties/name"},"synthetic_account_uid":{"type":"string","description":"A unique id referring to the mapped, general Synthetic Account.","example":"Dg1EPao8XukUpHG8"},"routing_number":{"allOf":[{"type":"string","maxLength":9,"minLength":9,"pattern":"^[0-9]{9}$","example":"123456789"},{"description":"The ABA routing number associated with this VRN."}]}},"required":["synthetic_account_uid","routing_number"]},"examples":{"create_payload":{"value":{"external_uid":"YrfDrfVRgpPgnhF5","name":"greenfield1","synthetic_account_uid":"Dg1EPao8XukUpHG8","routing_number":"123456789"}}}}}},"responses":{"201":{"description":"A single registered Virtual Reference Number is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"archived_at":{"type":"string","description":"The DateTime at which this VRN was archived. This value will be present if the status is archived. If in another state, the value will be null.","example":null},"created_at":{"type":"string","description":"The DateTime at which this VRN was created","example":"2023-10-04T13:23:04.345Z"},"custodial_account_uid":{"type":"string","description":"A unique id referring to the mapped, Custodial Account.","example":"tcvYpQ1ip76LaL4a"},"external_uid":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/put/requestBody/content/application~1json/schema/properties/external_uid"},"instant_payment_rail_registration_status":{"$ref":"#/paths/~1virtual_reference_numbers/get/parameters/0/schema"},"locked_at":{"type":"string","description":"The DateTime at which this VRN was locked. This value will be present if the status is locked. If in another state, the value will be null.","example":null},"lock_reason":{"type":"string","enum":["admin","customer_request"],"description":"Provided reason for locking the VRN.","example":null},"name":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/put/requestBody/content/application~1json/schema/properties/name"},"routing_number":{"type":"string","description":"The ABA routing number (if any) associated with this VRN.","example":"123456789"},"status":{"$ref":"#/paths/~1virtual_reference_numbers/get/parameters/1/schema"},"synthetic_account_uid":{"$ref":"#/paths/~1virtual_reference_numbers/get/parameters/2/schema"},"uid":{"type":"string","description":"Unique identifier for the VRN","example":"dYTG8WAWAh5UyvY7"},"virtual_reference_number_last_four":{"type":"string","description":"Last 4 digits of the VRN","example":"3456"}}},{"type":"object","properties":{"virtual_reference_number":{"type":"string","description":"The VRN","example":"1234567890123456"}}}]},"examples":{"pending":{"value":{"archived_at":null,"created_at":"2023-10-04T13:23:04.345Z","custodial_account_uid":"tcvYpQ1ip76LaL4a","external_uid":null,"instant_payment_rail_registration_status":"pending","locked_at":null,"lock_reason":null,"name":"greenfield1","routing_number":"123456789","status":"active","synthetic_account_uid":"Dg1EPao8XukUpHG8","uid":"dYTG8WAWAh5UyvY7","virtual_reference_number":1234567890123456,"virtual_reference_number_last_four":3456}}}}}},"422":{"description":"Creation Error","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":{"vrn_creation_error_sync":{"value":{"errors":[{"code":30001,"title":"Failed to create VRNs","detail":"An exception occurred while creating VRNs","occurred_at":"2023-10-04T13:23:04.345Z"}],"status":422}},"synthetic_account_ineligible_for_vrn":{"value":{"errors":[{"code":30002,"title":"The Synthetic Account provided is ineligible for VRNs","detail":"The Synthetic Account must be an active, general, liability account","occurred_at":"2023-10-04T13:23:04.345Z"}],"status":422}}}}}}}}},"/virtual_reference_numbers/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Virtual Reference Numbers"],"summary":"Get a single Virtual Reference Number","description":"Retrieves a single Virtual Reference Number resource along with its details, including status, linked Synthetic Account, and registration metadata.","responses":{"200":{"description":"A single Virtual Reference Number is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1virtual_reference_numbers/post/responses/201/content/application~1json/schema"},"examples":{"registered":{"value":{"archived_at":null,"created_at":"2023-10-04T13:23:04.345Z","custodial_account_uid":"tcvYpQ1ip76LaL4a","external_uid":null,"instant_payment_rail_registration_status":"registered","locked_at":null,"lock_reason":null,"name":"greenfield1","routing_number":"123456789","status":"active","synthetic_account_uid":"Dg1EPao8XukUpHG8","uid":"dYTG8WAWAh5UyvY7","virtual_reference_number":1234567890123456,"virtual_reference_number_last_four":3456}}}}}},"404":{"description":"The Virtual Reference Number is not found","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":{"unknown_virtual_reference_number":{"value":{"errors":[{"code":30000,"title":"Unknown VRN","detail":"Could not find Virtual Reference Number. Invalid VRN uid","occurred_at":"2023-10-04T13:23:04.345Z"}],"status":404}}}}}}}},"put":{"tags":["Virtual Reference Numbers"],"summary":"Edit a Virtual Reference Number","description":"Updates the metadata of an existing Virtual Reference Number. This may include changes to labels, descriptions, or Instant Payment registration settings.","requestBody":{"content":{"application/json":{"schema":{"properties":{"external_uid":{"allOf":[{"description":"A unique identifier the Client supplies. It must be unique within the resource type. If the same value is given, no new resource will be created.\n"},{"type":"string","minLength":1,"maxLength":255,"description":"A unique identifier the Client supplies. It must be unique within the resource type. If the same value is given, no new resource will be created.\n","example":"partner-generated-id"}]},"name":{"type":"string","description":"A unique name, per pool, to identify the resource.","maxLength":255,"example":"greenfield1"}}}}}},"responses":{"200":{"description":"The updated Virtual Reference Number resource is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1virtual_reference_numbers/post/responses/201/content/application~1json/schema"},"examples":{"registered":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/get/responses/200/content/application~1json/examples/registered"}}}}},"404":{"description":"The Virtual Reference Number is not found","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":{"unknown_virtual_reference_number":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/get/responses/404/content/application~1json/examples/unknown_virtual_reference_number"}}}}},"422":{"description":"Failed to update Virtual Reference Number","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":{"failed_to_update_vrn":{"summary":"Lock operation failed","description":"An exception occurred while updating VRNs","value":{"errors":[{"code":30004,"title":"Failed to update VRNs","detail":"An exception occurred while updating VRNs","occurred_at":"2023-10-04T13:23:04.345Z"}],"status":422}}}}}}}},"delete":{"tags":["Virtual Reference Numbers"],"summary":"Archive a single Virtual Reference Number","description":"Archives a Virtual Reference Number, removing it from active use. Archived VRNs cannot be used for incoming payments or reconciliation.","responses":{"204":{"description":"Virtual Reference Number is archived successfully","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1virtual_reference_numbers/post/responses/201/content/application~1json/schema"},"examples":{"archived":{"value":{"archived_at":"2023-10-15T15:53:13.591Z","created_at":"2023-10-04T13:23:04.345Z","custodial_account_uid":"tcvYpQ1ip76LaL4a","external_uid\"":"abcdefg1","name":"greenfield2","routing_number":"123456789","instant_payment_rail_registration_status":"registered","locked_at":null,"lock_reason":null,"status":"archived","synthetic_account_uid":"Dg1EPao8XukUpHG8","uid":"dYTG8WAWAh5UyvY7","virtual_reference_number":987654321654321,"virtual_reference_number_last_four":4321}}}}}},"404":{"description":"The Virtual Reference Number is not found","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":{"unknown_virtual_reference_number":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/get/responses/404/content/application~1json/examples/unknown_virtual_reference_number"}}}}}}}},"/virtual_reference_numbers/{uid}/lock":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"put":{"tags":["Virtual Reference Numbers"],"summary":"Lock a single Virtual Reference Number","description":"Locks a Virtual Reference Number to prevent new transactions or usage. This is typically used for fraud prevention or temporary deactivation.","requestBody":{"content":{"application/json":{"schema":{"properties":{"lock_reason":{"type":"string","enum":["admin","customer_request"],"description":"Lock reason","example":"disabled by client request"}},"required":["lock_reason"]}}}},"responses":{"200":{"description":"The locked Virtual Reference Number resource is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1virtual_reference_numbers/post/responses/201/content/application~1json/schema"},"examples":{"locked":{"value":{"archived_at":null,"created_at":"2023-10-04T13:23:04.345Z","custodial_account_uid":"tcvYpQ1ip76LaL4a","external_uid":null,"name":"greenfield1","routing_number":"123456789","instant_payment_rail_registration_status":"registered","locked_at":"2023-10-15T15:53:13.591Z","lock_reason":"customer_request","status":"active","synthetic_account_uid":"Dg1EPao8XukUpHG8","uid":"dYTG8WAWAh5UyvY7","virtual_reference_number":"1234567890123456,","virtual_reference_number_last_four":3456}}}}}},"404":{"description":"The Virtual Reference Number is not found","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":{"unknown_virtual_reference_number":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/get/responses/404/content/application~1json/examples/unknown_virtual_reference_number"}}}}},"422":{"description":"The Virtual Reference Number could not be locked","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":{"vrn_already_locked":{"summary":"VRN already locked","description":"Returned when the VRN is already locked and cannot be locked again.","value":{"errors":[{"code":30010,"title":"VRN is already locked","detail":"The Virtual Reference Number is already locked and cannot be locked again","occurred_at":"2023-10-04T13:23:04.345Z"}],"status":422}},"vrn_lock_cooldown_active":{"summary":"Lock cooldown active","description":"Returned when a lock cooldown is active and the VRN cannot be locked again yet.","value":{"errors":[{"code":30017,"title":"VRN cooldown active","detail":"VRN cannot be locked/unlocked until the cooldown period has ended","occurred_at":"2023-10-04T13:23:04.345Z"}],"status":422}},"virtual_reference_number_archived":{"summary":"Archived VRN","description":"Returned when the VRN is archived and cannot be acted upon.","value":{"errors":[{"code":30005,"title":"Archived VRN","detail":"Cannot use archived VRN","occurred_at":"2023-10-04T13:23:04.345Z"}],"status":422}},"failed_to_update_vrn":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/put/responses/422/content/application~1json/examples/failed_to_update_vrn"}}}}}}}},"/virtual_reference_numbers/{uid}/unlock":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"put":{"tags":["Virtual Reference Numbers"],"summary":"Unlock a single Virtual Reference Number","description":"Unlocks a previously locked Virtual Reference Number, restoring its ability to receive payments and participate in reconciliation workflows.","responses":{"200":{"description":"The locked Virtual Reference Number resource is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1virtual_reference_numbers/post/responses/201/content/application~1json/schema"},"examples":{"registered":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/get/responses/200/content/application~1json/examples/registered"}}}}},"404":{"description":"The Virtual Reference Number is not found","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":{"unknown_virtual_reference_number":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/get/responses/404/content/application~1json/examples/unknown_virtual_reference_number"}}}}},"422":{"description":"The Virtual Reference Number could not be unlocked","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":{"vrn_already_unlocked":{"summary":"VRN already unlocked","description":"Returned when the VRN is already unlocked and cannot be unlocked again.","value":{"errors":[{"code":30013,"title":"VRN is already unlocked","detail":"The Virtual Reference Number is already unlocked and cannot be unlocked again","occurred_at":"2023-10-04T13:23:04.345Z"}],"status":422}},"vrn_unlock_cooldown_active":{"summary":"Unlock cooldown active","description":"Returned when a unlock cooldown is active and the VRN cannot be unlocked again yet.","value":{"errors":[{"code":30018,"title":"VRN cooldown active","detail":"VRN cannot be locked/unlocked until the cooldown period has ended","occurred_at":"2023-10-04T13:23:04.345Z"}],"status":422}},"virtual_reference_number_archived":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D~1lock/put/responses/422/content/application~1json/examples/virtual_reference_number_archived"},"failed_to_update_vrn":{"$ref":"#/paths/~1virtual_reference_numbers~1%7Buid%7D/put/responses/422/content/application~1json/examples/failed_to_update_vrn"}}}}}}}},"/returns":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Returns"],"summary":"List Returns","description":"Retrieves a list of return transactions. You can filter the results based on parameters such as status, date, and transaction type. This endpoint is available in Sandbox and Production environments.\n","parameters":[{"name":"customer_uid","in":"query","schema":{"type":"string","description":"The UID of the customer requesting a return.","example":"Trzqy9t6j6tFGoG3"}},{"name":"requestor_type","in":"query","schema":{"type":"string","description":"Type of the customer requesting a return.","example":"customer","enum":["customer","subclient"]}}],"responses":{"200":{"description":"A list of Returns is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"created_at":{"type":"string","description":"The DateTime at which this Return was created.","example":null},"external_uid":{"$ref":"#/paths/~1returns/post/requestBody/content/application~1json/schema/properties/external_uid"},"original_transaction_uid":{"$ref":"#/paths/~1returns/post/requestBody/content/application~1json/schema/properties/original_transaction_uid"},"customer_uid":{"$ref":"#/paths/~1returns/get/parameters/0/schema"},"requestor_type":{"$ref":"#/paths/~1returns/get/parameters/1/schema"},"return_reason":{"$ref":"#/paths/~1returns/post/requestBody/content/application~1json/schema/properties/return_reason"},"return_transaction_uid":{"type":"string","description":"The transaction returning the funds.","example":"SMwKC1osz77DTEiu"},"status":{"type":"string","description":"A value indicating the overall status of the Return.\n","enum":["canceled","queued","pending","settled","failed"],"readOnly":true,"example":"pending"},"uid":{"type":"string","description":"Unique identifier for the Return","example":"dYTG8WAWAh5UyvY7"}}},"examples":{"returns_list":{"value":{"total_count":4,"count":2,"limit":2,"offset":0,"data":[{"created_at":"2024-05-01T00:00:00.000Z","external_uid":"null,","original_transaction_uid":"nwXnpBbX3A5sTki3","customer_uid":"Trzqy9t6j6tFGoG3","requestor_type":"customer","return_reason":"RLYGR8CO RMA Z452208-13","return_transaction_uid":"upKspzfHgAh47pHf","status":"settled","uid":"9ZZ87saSFLkkDG7z"},{"created_at":"2024-05-01T15:53:13.591Z","external_uid":"partner-created-id,","original_transaction_uid":"DbxJUHVuqt3C7hGK","customer_uid":"EhrQZJNjCd79LLYq","requestor_type":"subclient","return_reason":"Insufficient Funds","return_transaction_uid":"7UvkHn3Ss9AbWe2c","status":"pending","uid":"o1gSDeWvEt45Yuaa"}]}}}}}},"403":{"description":"Denied access to Returns","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer","description":"Code provided by Newline for reference","example":1234},"title":{"type":"string","description":"Title of Error Code","example":"Sorry, something went wrong"},"detail":{"type":"string","description":"Description of Error Code","example":"Details about it here."},"occurred_at":{"type":"string","description":"Error Timestamp","example":"2022-10-21T18:22:22.300Z"},"extra":{"type":"string","description":"Included based on Error Code; Additional context to help users self-solve the error","example":"Extra details are sometimes provided here."}}}},"status":{"type":"integer","description":"HTTP Status Code"}}},"examples":{"access_to_returns":{"value":{"errors":[{"code":18007,"title":"Returns not enabled","detail":"Returns are not enabled for this program.","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":403}}}}}},"422":{"description":"Failed to retrieve Returns","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":{"failed_to_retrieve_returns":{"value":{"errors":[{"code":31001,"title":"Failed to retrieve Returns","detail":"An exception occurred while retrieving Returns","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":422}}}}}}}},"post":{"tags":["Returns"],"summary":"Create a new Return","description":"Initiates a Return of an ACH or wire payment.\nA full ACH addenda is not available for ACH returns because an addenda record is used for the return itself; the `addenda_info` field contains the remaining available space.\nFor wire returns, the `wire_instruction` field is limited to 70 characters because Newline prefixes the instructions with the original wire transaction identifier (e.g., IMAD).\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"external_uid":{"type":"string","description":"Client supplied unique identifier. It must be unique within the customer. If the same value is given, no new resource will be created.","example":"YrfDrfVRgpPgnhF5"},"original_transaction_uid":{"type":"string","description":"The transaction to be returned.","example":"nwXnpBbX3A5sTki3"},"requesting_customer_uid":{"$ref":"#/paths/~1returns/get/parameters/0/schema"},"requestor_type":{"$ref":"#/paths/~1returns/get/parameters/1/schema"},"return_reason":{"type":"string","maxLength":140,"description":"Freeform text (up to 140 characters) documenting the reason for return. For wire returns, this value will be sent to the other bank.\n","example":"Insufficient Funds"},"ach":{"type":"object","properties":{"ach_return_code":{"type":"string","description":"The reason an ACH payment is being returned. Required if returning an RDFI transaction. Optional if reversing an ODFI transaction.\n","example":"R02","enum":["R01","R02","R03","R04","R06","R09","R10","R16","R17","R20","R23","R29","R31"]},"addenda_info":{"type":"string","description":"Freeform text (up to 44 characters) to attach a memo to return.","maxLength":44,"example":"TXN0055BADD1E cancelled"}}},"wire":{"type":"object","properties":{"wire_instructions":{"type":"string","maxLength":140,"description":"DEPRECATED. Use `return_reason` instead. Wire information for the return transaction (up to 140 characters).\n","example":"ORDER 5555555555"}}}},"required":["original_transaction_uid","requesting_customer_uid","requestor_type","return_reason"]},"examples":{"ach":{"value":{"original_transaction_uid":"nwXnpBbX3A5sTki3","requesting_customer_uid":"Trzqy9t6j6tFGoG3","requestor_type":"customer","return_reason":"RLYGR8CO RMA Z452208-13","ach":{"ach_return_code":"R02","addenda_info":"TXN0055BADD1E cancelled"}}},"wire":{"value":{"original_transaction_uid":"DbxJUHVuqt3C7hGK","requesting_customer_uid":"EhrQZJNjCd79LLYq","requestor_type":"customer","return_reason":"Refund issued by Bruno's Boxing for Order #5555555555","wire":{"wire_instructions":"ORDER 5555555555"}}}}}}},"responses":{"201":{"description":"A single registered Return is returned.","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1returns/get/responses/200/content/application~1json/schema"},{"type":"object","properties":{"ach":{"$ref":"#/paths/~1returns/post/requestBody/content/application~1json/schema/properties/ach"},"wire":{"$ref":"#/paths/~1returns/post/requestBody/content/application~1json/schema/properties/wire"}}}]},"examples":{"created_return":{"value":{"<<":{"created_at":"2024-05-01T00:00:00.000Z","external_uid":"null,","original_transaction_uid":"nwXnpBbX3A5sTki3","customer_uid":"Trzqy9t6j6tFGoG3","requestor_type":"customer","return_reason":"RLYGR8CO RMA Z452208-13","return_transaction_uid":"upKspzfHgAh47pHf","status":"settled","uid":"9ZZ87saSFLkkDG7z"},"ach":{"ach_return_code":"R02","addenda_info":"TXN0055BADD1E cancelled"}}}}}}},"400":{"description":"Creation Error","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":{"unknown_requestor_type":{"value":{"errors":[{"code":31003,"title":"Unknown Requestor Type","detail":"The requestor type is not recognized","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":400}},"bad_original_transaction_status":{"value":{"errors":[{"code":31005,"title":"Cannot Initiate Return","detail":"The given Transaction must be settled to issue Return","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":400}},"unsupported_return":{"value":{"errors":[{"code":31006,"title":"Unsupported Return","detail":"Returns are not supported for the given Transaction type","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":400}},"expired_return_window":{"value":{"errors":[{"code":31007,"title":"Expired Transaction","detail":"A Return can not be issued as specified; too much time has elapsed","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":400}},"network_code_unsupported":{"value":{"errors":[{"code":31008,"title":"Network code unsupported","detail":"Returns are not supported for Wires with UETR numbers","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":400}},"unsupported_original_transaction_code":{"value":{"errors":[{"code":31012,"title":"Unsupported Transaction Code","detail":"Returns are not supported for the original transaction code","occured_at":"2023-05-04T13:23:04.345Z"}],"status":400}},"cannot_return_a_return_transaction":{"value":{"errors":[{"code":31013,"title":"Cannot return a return","detail":"A return transaction cannot be returned.","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":400}},"cannot_return_an_ineligible_transaction":{"value":{"errors":[{"code":31014,"title":"Ineligible transaction","detail":"This transaction is not eligible to be returned.","occured_at":"2023-05-04T13:23:04.345Z"}],"status":400}}}}}},"403":{"description":"Denied access to Returns","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":{"access_to_returns":{"$ref":"#/paths/~1returns/get/responses/403/content/application~1json/examples/access_to_returns"}}}}},"422":{"description":"Creation Error","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":{"return_creation_error":{"value":{"errors":[{"code":31002,"title":"Could not create Return","detail":"An exception occurred while creating a Return","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":422}},"return_already_exists":{"value":{"errors":[{"code":31004,"title":"Return Already Exists","detail":"A Return already exists for the given Transaction","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":422}},"extraneous_payment_rail_info_for_return":{"value":{"errors":[{"code":31009,"title":"Extra payment information","detail":"Payment information was provided that is not required for this return.","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":422}},"information_unavailable_for_return":{"value":{"errors":[{"code":31010,"title":"Insufficient information for return.","detail":"The original transaction data required to submit a return is not available.","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":422}},"insufficient_time_to_process_return":{"value":{"errors":[{"code":31011,"title":"Insufficient time to process return.","detail":"The return cannot be processed because there is insufficient time remaining to process and submit the return to the appropriate institution.","occured_at":"2023-05-04T13:23:04.345Z"}],"status":422}}}}}}}}},"/returns/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Returns"],"summary":"Get a single Return","description":"Retrieves details about a specific return transaction, including its status, original transaction reference, and any associated metadata.","responses":{"200":{"description":"A single Return is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1returns/post/responses/201/content/application~1json/schema"},"examples":{"single_return":{"$ref":"#/paths/~1returns/post/responses/201/content/application~1json/examples/created_return"}}}}},"403":{"description":"Denied access to Returns","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1returns/get/responses/200/content/application~1json/schema"},"examples":{"access_to_returns":{"$ref":"#/paths/~1returns/get/responses/403/content/application~1json/examples/access_to_returns"}}}}},"404":{"description":"Unknown Return","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":{"unknown_return_uid":{"value":{"errors":[{"code":31000,"title":"Unknown Return","detail":"Could not find Return with the given uid","occurred_at":"2023-05-04T13:23:04.345Z"}],"status":404}}}}}}}}},"/combined_transfers":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"}],"get":{"tags":["Combined Transfers"],"summary":"List Combined Transfers","description":"Retrieves a list of Combined Transfers. These represent transactions where both a counterparty Synthetic Account and a Transfer were created in a single API call. You can filter results by status and other parameters.\n","parameters":[{"$ref":"#/paths/~1pools/get/parameters/1"},{"$ref":"#/paths/~1pools/get/parameters/2"},{"$ref":"#/paths/~1transactions/get/parameters/15"},{"$ref":"#/paths/~1transactions/get/parameters/16"},{"$ref":"#/paths/~1transfers/get/parameters/1"},{"name":"status","in":"query","schema":{"type":"string","enum":["queued","pending","failed","completed"],"example":"completed","description":"Filter by status. Multiple values are allowed, e.g. `status[]=queued&status[]=pending`.\n"}},{"name":"synthetic_account_external_uid","in":"query","schema":{"type":"string","example":"client-generated-id"},"description":"A unique, immutable id provided by the Client. Multiple values are allowed e.g. `synthetic_account_external_uid[]=uKxmLxUEiSj5h4M3&synthetic_account_external_uid[]=y9reyPMNEWuuYSC1`.\n"},{"name":"synthetic_account_pool_uid","in":"query","schema":{"type":"string","example":"wTSMX1GubP21ev2h"},"description":"Filter by Synthetic Account Pool. Multiple values are allowed, e.g. `synthetic_account_pool_uid[]=wTSMX1GubP21ev2h&synthetic_account_pool_uid[]=7UvkHn3Ss9AbWe2c`.\n"},{"name":"synthetic_account_uid","in":"query","schema":{"type":"string","example":"7UvkHn3Ss9AbWe2c"},"description":"Newline-generated unique id of the associated Synthetic Account. Multiple values are allowed, e.g. `synthetic_account_uid[]=wTSMX1GubP21ev2h&synthetic_account_uid[]=7UvkHn3Ss9AbWe2c`.\n"},{"name":"transfer_customer_uid","in":"query","schema":{"type":"string","example":"wTSMX1GubP21ev2h"},"description":"Filter by Synthetic Transfer Customer. Multiple values are allowed, e.g. `transfer_customer_uid[]=wTSMX1GubP21ev2h&transfer_customer_uid[]=7UvkHn3Ss9AbWe2c`.\n"},{"name":"transfer_external_uid","in":"query","schema":{"type":"string","example":"client-generated-id"},"description":"A unique, immutable id provided by the Client. Multiple values are allowed e.g. `transfer_external_uid[]=uKxmLxUEiSj5h4M3&transfer_external_uid[]=y9reyPMNEWuuYSC1`.\n"},{"name":"transfer_uid","in":"query","schema":{"type":"string","example":"7UvkHn3Ss9AbWe2c"},"description":"Newline-generated unique id of the associated Synthetic Transfer. Multiple values are allowed, e.g. `transfer_uid[]=wTSMX1GubP21ev2h&transfer_uid[]=7UvkHn3Ss9AbWe2c`.\n"}],"responses":{"200":{"description":"A list of Combined Transfers is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1pools/get/responses/200/content/application~1json/schema/allOf/0"},{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/paths/~1combined_transfers/post/responses/201/content/application~1json/schema"}]}}}}]},"examples":{"combined_transfers_list":{"value":{"total_count":4,"count":2,"limit":2,"offset":0,"data":[{"created_at":"2025-03-25T10:17:55.444Z","status":"completed","external_uid":"12345abcd","synthetic_account":{"external_uid":"abcd12345","name":"Spinach Fund","pool_uid":"axz9sbUgRVu5wqbw","routing_number":"04200031","synthetic_account_type_uid":"UyjH72G9KAhmbpNS","ach":{"account_type":"checking","counterparty_name":"awesome counterparty"},"uid":"dzc4FwjydgYAHpy9"},"transfer":{"destination_synthetic_account_uid":"azXvxqqcSsX9x9Yd","initiating_customer_uid":"PszWYuoA3CSUvAaq","initiator_type":"customer","usd_transfer_amount":"1.23","ach":{"effective_entry_date":"2025-03-27","entry_description":"Dividend Payment","originator_name":"Big Bank Inc","company_id":"COMPID1234","service_processing":"SAMEDAY","sec_code":"CCD","addenda":"valuable extra info"},"uid":"87CwVJLxYnRsEHLS"},"uid":"1BGeBkH7tU7REZVx"},{"created_at":"2025-03-27T09:23:07.890Z","status":"queued","external_uid":null,"synthetic_account":{"uid":"axz9sbUgRVu5wqbw"},"transfer":{"initiating_customer_uid":"PszWYuoA3CSUvAaq","initiator_type":"customer","source_synthetic_account_uid":"gfUHdwkR9kkEVxA4","usd_transfer_amount":"1.23","wire":{"intermediary_bank_name":"Big Bank Inc","intermediary_bank_address":{"line1":"123 Main St","line2":"Brooklyn NY","country":"US"},"intermediary_bank_routing_number":"123456789","wire_transmitter":{"name":"Bunker LLC","line1":"456 Second St","line2":"Queens NY","country":"US","transmitter_identifier":"1234567890"}},"uid":null},"uid":"iLCATodsXhKPpPRv"}]}}}}}},"403":{"description":"Denied access to Combined Transfers","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":{"combined_transfers_disabled":{"value":{"errors":[{"code":33004,"title":"Combined Transfers disabled","detail":"Combined Transfer endpoints are not enabled for this program","occured_at":"2025-03-27T09:23:07.890Z"}],"status":403}}}}}},"422":{"description":"Failed to retrieve Combined Transfers","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":{"failed_to_retrieve_combined_transfers":{"value":{"errors":[{"code":33006,"title":"Failed to retrieve Combined Transfers","detail":"An exception occurred while retrieving Combined Transfers","occured_at":"2025-03-27T09:23:07.890Z"}],"status":422}}}}}}}},"post":{"tags":["Combined Transfers"],"summary":"Create a new Combined Transfer","description":"Creates a Combined Transfer by simultaneously creating a counterparty Synthetic Account and initiating a Transfer. This streamlines asset movement by reducing the number of steps required to set up and execute a transaction.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"external_uid":{"type":"string","description":"Optional client-supplied uid","example":"YrfDrfVRgpPgnhF5"},"synthetic_account":{"allOf":[{"$ref":"#/paths/~1synthetic_accounts/post/requestBody/content/application~1json/schema"},{"type":"object","description":"Synthetic Account to be created or reused for a transfer. For more details on object structure, supported options and examples please refer to  [POST /synthetic_accounts](#tag/Synthetic-Accounts/paths/~1synthetic_accounts/post).\n"}]},"transfer":{"allOf":[{"$ref":"#/paths/~1transfers/post/requestBody/content/application~1json/schema"},{"type":"object","description":"Transfer details to initiate a transfer with. For more details on object structure, supported options and examples please refer to [POST /transfers](#tag/Transfers/paths/~1transfers/post). **NOTE:** Only source or destination synthetic account uid must be supplied for combined transfer, `synthetic_account` from the request will be used as the other party.\n"}]}},"required":["synthetic_account","transfer"]},"examples":{"ach_transfer_to_new_account":{"value":{"synthetic_account":{"account_number":"1234567890","external_uid":"abcd12345","name":"Spinach Fund","pool_uid":"axz9sbUgRVu5wqbw","routing_number":"04200031","synthetic_account_type_uid":"UyjH72G9KAhmbpNS","ach":{"account_type":"checking","counterparty_name":"awesome counterparty"}},"transfer":{"destination_synthetic_account_uid":"beHyJNeBU65Xv8LK","initiating_customer_uid":"axz9sbUgRVu5wqbw","usd_transfer_amount":"12.34","initiator_type":"customer","ach":{"destination_synthetic_account_uid":"azXvxqqcSsX9x9Yd","initiating_customer_uid":"PszWYuoA3CSUvAaq","initiator_type":"customer","usd_transfer_amount":"1.23","ach":{"effective_entry_date":"2025-03-27","entry_description":"Dividend Payment","originator_name":"Big Bank Inc","company_id":"COMPID1234","service_processing":"SAMEDAY","sec_code":"CCD","addenda":"valuable extra info"},"uid":"87CwVJLxYnRsEHLS"}}}},"ach_transfer_to_existing_account":{"value":{"synthetic_account":{"uid":"dzc4FwjydgYAHpy9"},"transfer":{"destination_synthetic_account_uid":"beHyJNeBU65Xv8LK","initiating_customer_uid":"axz9sbUgRVu5wqbw","usd_transfer_amount":"12.34","initiator_type":"customer","ach":{"destination_synthetic_account_uid":"azXvxqqcSsX9x9Yd","initiating_customer_uid":"PszWYuoA3CSUvAaq","initiator_type":"customer","usd_transfer_amount":"1.23","ach":{"effective_entry_date":"2025-03-27","entry_description":"Dividend Payment","originator_name":"Big Bank Inc","company_id":"COMPID1234","service_processing":"SAMEDAY","sec_code":"CCD","addenda":"valuable extra info"},"uid":"87CwVJLxYnRsEHLS"}}}},"instant_payment_transfer_to_new_account":{"value":{"synthetic_account":{"account_number":"1234567890","external_uid":"abcd12345","name":"Spinach Fund","pool_uid":"axz9sbUgRVu5wqbw","routing_number":"04200031","synthetic_account_type_uid":"UyjH72G9KAhmbpNS","instant_payment":{"email":"address@domain.com","counterparty_name":"awesome counterparty","phone":"2121112233","counterparty_address":{"street_number":123,"street1":"Main street","city":"Brooklyn","state":"IA","postal_code":"12345-6789","country":"US"}}},"transfer":{"destination_synthetic_account_uid":"beHyJNeBU65Xv8LK","initiating_customer_uid":"axz9sbUgRVu5wqbw","usd_transfer_amount":"12.34","initiator_type":"customer","instant_payment":{"instant_payment_transmitter":{"name":"Royalty Asset Management","transmitter_identifier":"123456789","street_number":123,"street1":"Abc St.","city":"Boring","state":"OR","postal_code":97009},"memo":"To unfreeze the prince's assets"}}}},"instant_payment_transfer_to_existing_account":{"value":{"synthetic_account":{"uid":"dzc4FwjydgYAHpy9"},"transfer":{"destination_synthetic_account_uid":"beHyJNeBU65Xv8LK","initiating_customer_uid":"axz9sbUgRVu5wqbw","usd_transfer_amount":"12.34","initiator_type":"customer","instant_payment":{"instant_payment_transmitter":{"name":"Royalty Asset Management","transmitter_identifier":"123456789","street_number":123,"street1":"Abc St.","city":"Boring","state":"OR","postal_code":97009},"memo":"To unfreeze the prince's assets"}}}},"wire_transfer_to_new_account":{"value":{"synthetic_account":{"account_number":"1234567890","external_uid":"abcd12345","name":"Spinach Fund","pool_uid":"axz9sbUgRVu5wqbw","routing_number":"04200031","synthetic_account_type_uid":"UyjH72G9KAhmbpNS","wire":{"counterparty_name":"Awesome Counterparty","counterparty_bank_name":"Biggest Bank Inc"}},"transfer":{"destination_synthetic_account_uid":"beHyJNeBU65Xv8LK","initiating_customer_uid":"axz9sbUgRVu5wqbw","usd_transfer_amount":"12.34","initiator_type":"customer","wire":{"intermediary_bank_name":"Big Bank Inc","intermediary_bank_address":{"line1":"123 Main St","line2":"Brooklyn NY","country":"US"},"intermediary_bank_routing_number":"123456789","wire_transmitter":{"name":"Bunker LLC","line1":"456 Second St","line2":"Queens NY","country":"US","transmitter_identifier":"1234567890"}}}}},"wire_transfer_to_existing_account":{"value":{"synthetic_account":{"uid":"dzc4FwjydgYAHpy9"},"transfer":{"destination_synthetic_account_uid":"beHyJNeBU65Xv8LK","initiating_customer_uid":"axz9sbUgRVu5wqbw","usd_transfer_amount":"12.34","initiator_type":"customer","wire":{"intermediary_bank_name":"Big Bank Inc","intermediary_bank_address":{"line1":"123 Main St","line2":"Brooklyn NY","country":"US"},"intermediary_bank_routing_number":"123456789","wire_transmitter":{"name":"Bunker LLC","line1":"456 Second St","line2":"Queens NY","country":"US","transmitter_identifier":"1234567890"}}}}}}}}},"responses":{"201":{"description":"A single Combined Transfer is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"created_at":{"type":"string","description":"Timestamp of when the combined_transfer was created","example":"2025-03-27T09:23:07.890Z"},"errors":{"type":"array","description":"A collection of errors that occured during synthetic account and/or transfer creation. Only displayed if errors were detected.\n","items":{"$ref":"#/paths/~1returns/get/responses/403/content/application~1json/schema/properties/errors/items"},"example":[{"code":33005,"title":"Could not continue Combined Transfer","detail":"An exception occurred while continuing a Combined Transfer","occured_at":"2025-03-27T09:23:07.890Z"}]},"external_uid":{"$ref":"#/paths/~1combined_transfers/post/requestBody/content/application~1json/schema/properties/external_uid"},"status":{"description":"The combined transfer's status","type":"string","example":"pending","enum":["queued","pending","failed","completed"]},"synthetic_account":{"type":"object","description":"Parameters provided at time of creation. UID field will get populated once synthetic account has been successfully created, unless uid value was supplied at creation time.\n"},"transfer":{"type":"object","description":"Parameters provided at time of creation. UID field will get populated once transfer has been successfully initiated.\n"},"uid":{"type":"string","description":"Unique identifier for the Combined Transfer","example":"dYTG8WAWAh5UyvY7"}}},"examples":{"queued":{"value":{"created_at":"2025-03-27T09:23:07.890Z","status":"queued","external_uid":null,"synthetic_account":{"external_uid":"abcd12345","name":"Spinach Fund","pool_uid":"axz9sbUgRVu5wqbw","routing_number":"04200031","synthetic_account_type_uid":"UyjH72G9KAhmbpNS","wire":{"counterparty_name":"Awesome Counterparty","counterparty_bank_name":"Biggest Bank Inc"},"uid":null},"transfer":{"destination_synthetic_account_uid":"azXvxqqcSsX9x9Yd","initiating_customer_uid":"PszWYuoA3CSUvAaq","initiator_type":"customer","source_synthetic_account_uid":"gfUHdwkR9kkEVxA4","usd_transfer_amount":"1.23","wire":{"intermediary_bank_name":"Big Bank Inc","intermediary_bank_address":{"line1":"123 Main St","line2":"Brooklyn NY","country":"US"},"intermediary_bank_routing_number":"123456789","wire_transmitter":{"name":"Bunker LLC","line1":"456 Second St","line2":"Queens NY","country":"US","transmitter_identifier":"1234567890"}},"uid":null},"uid":"iLCATodsXhKPpPRv"}}}}}},"403":{"description":"Denied access to Combined Transfers","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":{"combined_transfers_disabled":{"$ref":"#/paths/~1combined_transfers/get/responses/403/content/application~1json/examples/combined_transfers_disabled"}}}}},"422":{"description":"Creation Error","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":{"combined_transfer_creation_error":{"value":{"errors":[{"code":33001,"title":"Could not create Combined Transfer","detail":"An exception occurred while creating a Combined Transfer","occured_at":"2025-03-27T09:23:07.890Z"}],"status":422}},"combined_transfer_external_uid_taken":{"value":{"errors":[{"code":33007,"title":"Combined Transfer external uid is already taken","detail":"Combined Transfer external uid must be unique","occured_at":"2025-03-27T09:23:07.890Z"}],"status":422}}}}}}}}},"/combined_transfers/{uid}":{"parameters":[{"$ref":"#/paths/~1auth/parameters/0"},{"$ref":"#/paths/~1pools~1%7Buid%7D/parameters/1"}],"get":{"tags":["Combined Transfers"],"summary":"Get a single Combined Transfer","description":"Retrieves details about a specific Combined Transfer, including the status, participating accounts, and associated metadata. Statuses include `queued`, `pending`, `failed`, and `completed`.","responses":{"200":{"description":"A single Combined Transfer is returned","headers":{"x-trace-id":{"$ref":"#/paths/~1auth/post/responses/201/headers/x-trace-id"}},"content":{"application/json":{"schema":{"$ref":"#/paths/~1combined_transfers/post/responses/201/content/application~1json/schema"},"examples":{"queued":{"$ref":"#/paths/~1combined_transfers/post/responses/201/content/application~1json/examples/queued"},"pending":{"value":{"created_at":"2025-03-27T09:23:07.890Z","status":"pending","external_uid":null,"synthetic_account":{"external_uid":"abcd12345","name":"Spinach Fund","pool_uid":"axz9sbUgRVu5wqbw","routing_number":"04200031","synthetic_account_type_uid":"UyjH72G9KAhmbpNS","wire":{"counterparty_name":"Awesome Counterparty","counterparty_bank_name":"Biggest Bank Inc"},"uid":null},"transfer":{"destination_synthetic_account_uid":"azXvxqqcSsX9x9Yd","initiating_customer_uid":"PszWYuoA3CSUvAaq","initiator_type":"customer","source_synthetic_account_uid":"gfUHdwkR9kkEVxA4","usd_transfer_amount":"1.23","wire":{"intermediary_bank_name":"Big Bank Inc","intermediary_bank_address":{"line1":"123 Main St","line2":"Brooklyn NY","country":"US"},"intermediary_bank_routing_number":"123456789","wire_transmitter":{"name":"Bunker LLC","line1":"456 Second St","line2":"Queens NY","country":"US","transmitter_identifier":"1234567890"}},"uid":null},"uid":"iLCATodsXhKPpPRv"}},"failed":{"value":{"created_at":"2025-03-27T09:23:07.890Z","status":"failed","errors":[{"code":33005,"title":"Could not continue Combined Transfer","detail":"An exception occurred while continuing a Combined Transfer","occured_at":"2025-03-27T09:23:07.890Z"}],"external_uid":null,"synthetic_account":{"external_uid":"abcd12345","name":"Spinach Fund","pool_uid":"axz9sbUgRVu5wqbw","routing_number":"04200031","synthetic_account_type_uid":"UyjH72G9KAhmbpNS","wire":{"counterparty_name":"Awesome Counterparty","counterparty_bank_name":"Biggest Bank Inc"},"uid":null},"transfer":{"destination_synthetic_account_uid":"azXvxqqcSsX9x9Yd","initiating_customer_uid":"PszWYuoA3CSUvAaq","initiator_type":"customer","source_synthetic_account_uid":"gfUHdwkR9kkEVxA4","usd_transfer_amount":"1.23","wire":{"intermediary_bank_name":"Big Bank Inc","intermediary_bank_address":{"line1":"123 Main St","line2":"Brooklyn NY","country":"US"},"intermediary_bank_routing_number":"123456789","wire_transmitter":{"name":"Bunker LLC","line1":"456 Second St","line2":"Queens NY","country":"US","transmitter_identifier":"1234567890"}},"uid":null},"uid":"iLCATodsXhKPpPRv"}},"completed":{"value":{"created_at":"2025-03-27T09:23:07.890Z","status":"completed","external_uid":null,"synthetic_account":{"external_uid":"abcd12345","name":"Spinach Fund","pool_uid":"axz9sbUgRVu5wqbw","routing_number":"04200031","synthetic_account_type_uid":"UyjH72G9KAhmbpNS","wire":{"counterparty_name":"Awesome Counterparty","counterparty_bank_name":"Biggest Bank Inc"},"uid":"dzc4FwjydgYAHpy9"},"transfer":{"destination_synthetic_account_uid":"azXvxqqcSsX9x9Yd","initiating_customer_uid":"PszWYuoA3CSUvAaq","initiator_type":"customer","source_synthetic_account_uid":"gfUHdwkR9kkEVxA4","usd_transfer_amount":"1.23","wire":{"intermediary_bank_name":"Big Bank Inc","intermediary_bank_address":{"line1":"123 Main St","line2":"Brooklyn NY","country":"US"},"intermediary_bank_routing_number":"123456789","wire_transmitter":{"name":"Bunker LLC","line1":"456 Second St","line2":"Queens NY","country":"US","transmitter_identifier":"1234567890"}},"uid":"87CwVJLxYnRsEHLS"},"uid":"iLCATodsXhKPpPRv"}}}}}},"403":{"description":"Denied access to Combined Transfers","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":{"combined_transfers_disabled":{"$ref":"#/paths/~1combined_transfers/get/responses/403/content/application~1json/examples/combined_transfers_disabled"}}}}},"404":{"description":"The Combined Transfer is not found","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":{"unknown_combined_transfer":{"value":{"errors":[{"code":33000,"title":"Unknown combined transfer","detail":"Could not find combined transfer","occured_at":"2025-03-27T09:23:07.890Z"}],"status":404}}}}}}}}}}}