> ## 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. # Cancel an outgoing wire > Cancel an outgoing tranfer ## OpenAPI ````yaml openapi.json patch /wires/{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/{wire_id}: summary: Wire patch: tags: - Wires summary: Cancel an outgoing wire description: Cancel an outgoing tranfer operationId: cancelWire parameters: - $ref: '#/components/parameters/wire_id' - $ref: '#/components/parameters/idempotency_key' requestBody: content: application/json: schema: $ref: '#/components/schemas/update_transfer' description: wire to update required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/wire' description: Updated wire '400': $ref: '#/components/responses/bad_request' '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 idempotency_key: description: >- An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry. in: header name: Idempotency-Key schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string schemas: update_transfer: properties: status: description: >- Field value must be set to CANCELED. It can only be changed when status is PENDING. enum: - CANCELED example: CANCELED type: string required: - status title: Change Status type: object wire: properties: amount: description: Transfer amount in cents ($100 would be 10000) example: 10000 type: integer bank_message: description: >- Instructions intended for the financial institutions that are processing the wire. type: string batch_id: description: >- The batch ID associated with the wire if it was created via the batch payment API. format: uuid type: string case_id: description: The case id associated with the wire. example: 53 format: integer64 type: integer 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 effective_date: description: The effective date of the transaction once it gets posted example: '2022-03-18' format: date type: string fed_input_message_accountability_data: description: >- The Synctera-generated IMAD can be overwritten when the wire is uploaded to the FED. If that happens and we are provided with the new IMAD, it will be populated in this field. example: 10220318BANK0001123456 type: string id: description: wire ID format: uuid readOnly: true type: string input_message_accountability_data: description: >- The input message accountability data consists of a 8 character cycle date (CCYYMMDD) an 8 character source and a 6 character sequence number. example: 10220318BANK0001123456 readOnly: true type: string is_bulk: description: >- Whether or not the wire is a "bulk" wire created via the batch payment API. type: boolean last_updated_time: example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string network: description: The network used to process the wire example: fedwire type: string originating_account_id: description: Sender account ID example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string originating_account_number: description: >- The account number representing the sender account. If the outgoing wire is a return, it refers to the sender of the initial wire not the sender of the return. example: 1961234745 format: string type: string receiving_account_id: description: The external 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 representing the recipient account. If the outgoing wire is a return, it refers to the recipient of the initial wire not the destination of the return. 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' 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 once it gets posted example: '2022-03-18' format: date type: string status: description: The current status of the transfer enum: - CANCELED - COMPLETED - DECLINED - PENDING example: PENDING readOnly: true type: string status_details: description: Additional details about the status of the transfer enum: - APPROVED - CANCELED - DECLINED_DUAL_APPROVAL - PENDING_DUAL_APPROVAL example: PENDING_DUAL_APPROVAL type: string transaction_id: description: ID of the resulting transaction resource format: uuid readOnly: true type: string transaction_in_id: description: >- The transaction uuid of the incoming wire that triggered an outgoing return. This is only used if the outgoing wire is a return. example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string required: - amount - creation_time - currency - effective_date - id - is_bulk - last_updated_time - originating_account_number - receiving_account_number - sender_reference_id - status - transaction_id title: Wire 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 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 responses: bad_request: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: BadRequest 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 ````