openapi: 3.0.0
info:
  title: IngoPay — Verify Wire Transfer
  version: 1.0.0
  description: >-
    This endpoint is currently under development. Specifications are subject to
    change prior to general availability.


    Tokenize a wire transfer account for use in subsequent Process requests.
  contact:
    name: Ingo Payments Integrations
    url: https://developers.ingopayments.com
servers:
  - url: https://sandbox-api.ingomoney.com
    description: Sandbox
  - url: https://api.ingomoney.com
    description: Production
paths:
  /gateway/verify--wire:
    post:
      operationId: verifyWire
      tags:
        - Wire Transfer
      summary: Tokenize a Wire Transfer Account
      description: >-
        ⚠️ **Under Development — Coming Soon.** This endpoint is currently under
        development. Specifications are subject to change prior to general
        availability.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyWireRequest'
      responses:
        '200':
          description: Successful tokenization response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyWireResponse'
components:
  schemas:
    VerifyWireRequest:
      type: object
      description: Wire transfer account tokenization request.
      properties:
        participant_id:
          type: integer
          description: Unique participant identifier assigned by Ingo.
        account_type:
          type: string
          description: Value should be set to ‘WT’.
          maxLength: 2
        customer_account_token:
          type: string
          description: customer_account_token
        amount:
          type: number
          description: >-
            Amount of disbursement. Max value determined by participant velocity
            limits.
        recipient_first_name:
          type: string
          description: >-
            Recipient first name. Not required if a valid customer_account_token
            is provided.
          maxLength: 255
        recipient_last_name:
          type: string
          description: >-
            Recipient last name. Not required if a valid customer_account_token
            is provided.
          maxLength: 255
        recipient_business_name:
          type: string
          description: Optional recipient business name.
          maxLength: 150
        recipient_address1:
          type: string
          description: >-
            Recipient address 1. Not required if a valid customer_account_token
            is provided.
          maxLength: 255
        recipient_address2:
          type: string
          description: Recipient address 2.
          maxLength: 255
        recipient_city:
          type: string
          description: >-
            Recipient city. Not required if a valid customer_account_token is
            provided.
          maxLength: 255
        recipient_state:
          type: string
          description: >-
            Recipient state (standard postal abbreviation). Not required if a
            valid customer_account_token is provided.
          maxLength: 2
        recipient_zip:
          type: string
          description: >-
            Recipient zip (5-digit zip or 10-digit zip plus 4 in xxxxx-xxxx
            format). Not required if a valid customer_account_token is provided.
          maxLength: 10
        recipient_phone:
          type: integer
          description: 10-digit recipient phone.
        account:
          type: string
          description: >-
            Account number. Not required if a valid customer_account_token is
            provided.
          maxLength: 255
        routing_number:
          type: string
          description: Bank routing number associated with the account number.
          maxLength: 9
        participant_unique_id1:
          type: string
          description: participant_unique_id1
        participant_unique_id2:
          type: string
          description: participant_unique_id2
        timestamp:
          type: integer
          description: Unix timestamp.
        version:
          type: integer
          description: 'Current version is: 11'
        status:
          type: integer
          description: status
        client_message:
          type: string
          description: client_message
        data:
          type: object
          description: data
        last_4:
          type: string
          description: last_4
        request_timestamp:
          type: integer
          description: request_timestamp
        issuers:
          type: object
          description: issuers
        payee_id:
          type: string
          description: payee_id
        payee_name:
          type: string
          description: payee_name
        payee_address:
          type: string
          description: payee_address
        payee_city:
          type: string
          description: payee_city
        payee_state:
          type: string
          description: payee_state
        payee_zip:
          type: string
          description: payee_zip
        credit_info:
          type: object
          description: credit_info
        min:
          type: string
          description: min
        max:
          type: string
          description: max
        card_type:
          type: string
          description: card_type
        estimated_posting_time:
          type: string
          description: estimated_posting_time
        estimated_posting_date:
          type: string
          description: estimated_posting_date
        debit_info:
          type: string
          description: debit_info
        issuing_network:
          type: string
          description: issuing_network
        credit_enabled:
          type: integer
          description: credit_enabled
        debit_enabled:
          type: integer
          description: debit_enabled
        count:
          type: integer
          description: count
        time:
          type: string
          description: time
    VerifyWireResponse:
      type: object
      description: Wire transfer tokenization response.
      properties:
        status:
          type: integer
          description: Gateway status code. 100 = Success.
          example: 100
        client_message:
          type: string
          description: Human-readable status message.
          example: Success
        data:
          type: object
          description: Response data.
          properties:
            customer_account_token:
              type: string
              description: Opaque token representing the tokenized wire account.
              example: tok-wire-001
        time:
          type: string
          description: Request processing time in seconds.
          example: '0.85'