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


    Pull funds via wire transfer (drawdown request).
  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/v12/debit/process--wire:
    post:
      operationId: processWireDrawdown
      tags:
        - Wire Drawdown
      summary: Pull Funds via Wire Drawdown
      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/WireDrawdownRequest'
      responses:
        '200':
          description: Wire drawdown response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WireDrawdownResponse'
components:
  schemas:
    WireDrawdownRequest:
      type: object
      description: Wire drawdown (pull) request.
      properties:
        request:
          type: string
          description: REQUIRED
        participant_id:
          type: string
          description: REQUIRED
        timestamp:
          type: string
          description: REQUIRED
        transaction:
          type: string
          description: REQUIRED
        account_type:
          type: string
          description: REQUIRED
        transaction_amount:
          type: string
          description: OPTIONAL
        currency_code:
          type: string
          description: REQUIRED
        amount:
          type: string
          description: REQUIRED
        transaction_wire_additional:
          type: string
          description: OPTIONAL
        info_for_receiver:
          type: string
          description: REQUIRED
        line_1:
          type: string
          description: REQUIRED
        line_2:
          type: string
          description: OPTIONAL
        line_3:
          type: string
          description: OPTIONAL
        line_4:
          type: string
          description: OPTIONAL
        participant_unique_ids:
          type: string
          description: REQUIRED
        participant_unique_id1:
          type: string
          description: REQUIRED
        participant_unique_id2:
          type: string
          description: OPTIONAL
        customer_account_token:
          type: string
          description: REQUIRED
        source_of_funds:
          type: string
          description: REQUIRED
        recipient_phone:
          type: string
          description: OPTIONAL
        ledger:
          type: string
          description: CONDITIONAL
        api_key:
          type: string
          description: REQUIRED
        user_id:
          type: string
          description: REQUIRED
        entity_type:
          type: string
          description: REQUIRED
        entity_id:
          type: string
          description: REQUIRED
        response:
          type: string
          description: REQUIRED
        status:
          type: string
          description: REQUIRED
        message:
          type: string
          description: REQUIRED
        duration:
          type: string
          description: REQUIRED
        transaction_id:
          type: string
          description: REQUIRED
        estimated_posting_time:
          type: string
          description: REQUIRED
        estimated_posting_date:
          type: string
          description: REQUIRED
    WireDrawdownResponse:
      type: object
      description: Wire drawdown 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.
        time:
          type: string
          description: Request processing time in seconds.
          example: '0.85'