> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # Get incoming wire by id > Get an incoming wire by id ## OpenAPI ````yaml openapi.json get /wires/incoming/{wire_id} openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 0.208.0 servers: - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v0 - description: Production url: https://api.synctera.com/v0 security: - bearerAuth: [] tags: - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests to link and manage External Cards name: External Cards - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Create and manage wire transfers name: Wires - description: Requests to issue and manage Cards name: Cards - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Requests to create and manage API keys name: API Keys - description: Requests to create and manage ban rules name: Ban Rules - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Request to create and manage exclusions name: Stately - description: Request to create and manage partner configurations name: Quickstart - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to create licenses name: Licenses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Requests to search financial institutions name: Institutions (Beta) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to initiate customer verification. name: KYC/KYB Verifications paths: /wires/incoming/{wire_id}: get: tags: - Wires summary: Get incoming wire by id description: Get an incoming wire by id operationId: getIncomingWire parameters: - $ref: '#/components/parameters/wire_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/incoming_wire' description: wire '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '500': $ref: '#/components/responses/internal_server_error' components: parameters: wire_id: description: The unique identifier of a wire transfer. in: path name: wire_id required: true schema: example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string schemas: incoming_wire: properties: amount: description: Transfer amount in cents ($100 would be 10000) example: 10000 type: integer bank_message: description: Information from the sending bank to the receiving bank. type: string creation_time: example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string currency: description: 3-character currency code example: USD type: string customer_id: description: >- The customer UUID representing the person initiating the Wire transfer example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string decline_reason: description: Description of any errors or problems encountered during processing. type: string effective_date: description: The effective date of the transaction example: '2022-03-18' format: date type: string end_to_end_identification: description: >- A mandatory reference assigned by the customer originating the payment, i.e., Debtor or Ultimate Debtor that must be transported unchanged throughout the payment chain and delivered to the end-customer, i.e., Creditor or Ultimate Creditor to facilitate the customer’s reconciliation. type: string extracted_account_number: description: >- Account number recovered from the unstructured recipient message when the structured beneficiary account number was missing or unusable. When the value matches a known account exactly, the wire is forwarded to the standard posting flow; otherwise it falls to suspense and ops can review this candidate. example: '1961234745' readOnly: true type: string id: description: wire ID format: uuid readOnly: true type: string input_message_accountability_data: description: >- The IMAD of the incoming wire. The field is called Message Identification in the ISO format. example: 10220318BANK0001123456 readOnly: true type: string instruction_identification: description: >- An optional reference that the Fedwire Funds participant sending the message may include in a customer credit transfers sent across the Fedwire Funds Service and will be delivered unchanged to the Fedwire Funds participant receiving the message. type: string is_return: description: Indicates if the wire is a return of an outgoing wire type: boolean network: description: The network used to process the wire example: fedwire type: string originating_account_number: description: The account number of the sender, as provided in the wire file. example: 1961234745 format: string type: string receiver: $ref: '#/components/schemas/party' receiving_account_id: description: >- The internal Synctera account uuid representing the recipient of the wire. example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string receiving_account_number: description: The account number of the recipient, as provided in the wire file. example: 1961234745 format: string type: string recipient_message: description: Information from the originator to the beneficiary (recipient). type: string return_data: $ref: '#/components/schemas/return_data1' return_reason: description: The reason we are returning this wire. type: string sender: $ref: '#/components/schemas/party' sender_reference_id: description: Sender's id associated with fedwire transfer example: 9F564A6124E65 readOnly: true type: string settlement_date: description: The settlement date of the transaction example: '2022-03-18' format: date type: string status: description: The current status of the transfer enum: - BLOCKED - POSTED - READY - RETURNED example: READY readOnly: true type: string tenant: $ref: '#/components/schemas/tenant_id' transaction_id: description: ID of the resulting transaction resource format: uuid readOnly: true type: string transaction_identification: description: >- An optional reference that the first financial institution in the end-to-end payment chain may assign to the customer credit transfer and that should remain unchanged throughout the end-to-end funds-transfer chain of financial institutions. type: string type_subtype: description: The fedwire label associated with the subtype code enum: - BASIC_FUNDS_TRANSFER - PRIOR_DAY_TRANSFER_REVERSAL - RETURN - SAME_DAY_TRANSFER_REVERSAL example: BASIC_FUNDS_TRANSFER type: string uetr: description: >- Unique End-To-End Reference (UETR) is a mandatory reference in line with the Universally Unique Identifier (UUID) version 4 standard. The UETR is used to facilitate end-to-end payments tracking. format: uuid type: string required: - amount - creation_time - id - is_return - receiver - receiving_account_number - sender - sender_reference_id - status - tenant title: Incoming Wire type: object party: description: Information about a party in a wire transfer properties: account_number: description: account number of the person example: 192178512 readOnly: true type: string address: $ref: '#/components/schemas/address3' address_lines: $ref: '#/components/schemas/address_lines' alternate_identifier: description: alternate identifier of the party, used in place of account number example: 123456789 readOnly: true type: string bank_name: description: name of the bank this party is a member of example: Synctera Bank readOnly: true type: string identifier_type: description: type of value used to identify the party example: Demand Deposit Account Number readOnly: true type: string name: description: name of the person example: John Smith readOnly: true type: string routing_number: description: routing number of the bank this person is a member of example: 272479663 readOnly: true type: string title: Person type: object return_data1: description: Data associated with a returned wire properties: original_end_to_end_identification: type: string original_id: description: >- UUID of the original wire that was returned. This field is populated if the system successfully matches the return to an original wire. format: uuid type: string original_instruction_identification: type: string original_transaction_id: description: >- Ledger transaction UUID of the original wire that was returned. This field is populated if the system successfully matches the return to an original wire. format: uuid type: string original_transaction_identification: type: string original_uetr: type: string previous_message_id: description: IMAD of the original wire that was returned type: string reason: description: Additional information regarding the cause of the return type: string reason_code: description: The code associated with the return reason example: NARR type: string required: - previous_message_id title: Return Data type: object tenant_id: description: > The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. example: abcdef_ghijkl type: string error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'missing required fields: first_name, dob' type: string status: description: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object address3: properties: address_line_1: description: street address example: 321 Main St type: string address_line_2: description: street address example: Apt 34 type: string city: description: city example: Chicago type: string country_code: description: country code example: US type: string postal_code: description: postal code example: '60622' type: string state: description: state example: IL type: string title: Address type: object address_lines: properties: address_line_1: description: address line 1 from wire file readOnly: true type: string address_line_2: description: address line 2 from wire file readOnly: true type: string address_line_3: description: address line 3 from wire file readOnly: true type: string title: Address Lines type: object responses: unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error not_found: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Resource not found internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````