> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blips.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Create same-currency outgoing payout or withdrawal

> Create a same-currency outgoing payout or withdrawal from a customer internal account to a bound external account.



## OpenAPI

````yaml /openapi/blips-public-reference.yaml post /transfer-out
openapi: 3.1.0
info:
  title: BLIPS Public Reference API
  version: '2026-04-08'
  description: >-
    Public OpenAPI 3.1 subset for the first BLIPS Mintlify API Reference and
    Playground release. This document is bound to the confirmed Public Test
    Backend at https://public-test.blips.network, includes only the approved
    first-release public endpoints, uses only internal `$ref` values, and
    excludes callback-only webhook documentation and operator-only surfaces.
servers:
  - url: https://public-test.blips.network
    description: >-
      Confirmed Public Test Backend ingress target for public BLIPS API
      Reference, Playground, and internet-testable Try It flows.
security:
  - BasicAuth: []
tags:
  - name: Platform Setup
    description: >-
      Bootstrap and platform configuration surfaces for establishing the public
      BLIPS integration context.
  - name: Sandbox API
    description: >-
      Sandbox-only externally displayed helper surfaces. These routes either
      adjust quote inputs or create incoming-payment review cases, but they
      always feed the existing quote or transaction families and never become
      second outward API families.
  - name: Tokens
    description: >-
      Platform-scoped API credential create, list, detail, and revoke
      operations.
  - name: Customers
    description: >-
      Customer onboarding, profile lifecycle, and PPV payment-address issuance
      surfaces.
  - name: Accounts
    description: >-
      Customer-bound internal-account and external-account surfaces kept in the
      first-layer public contract.
  - name: Same-Currency Transfers
    description: >-
      Same-currency receiver lookup plus incoming and outgoing transfer
      primitives.
  - name: Cross-Currency Transfers
    description: >-
      PPV-first receiver lookup, quote creation/readback, and quote execution
      for cross-currency flows.
  - name: Transactions
    description: Transaction readback plus bounded incoming-review decision operations.
  - name: Webhooks
    description: >-
      Webhook connectivity verification surface for the public BLIPS
      integration.
paths:
  /transfer-out:
    post:
      tags:
        - Same-Currency Transfers
      summary: Create same-currency outgoing payout or withdrawal
      description: >-
        Create a same-currency outgoing payout or withdrawal from a customer
        internal account to a bound external account.
      operationId: createTransferOut
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
          description: >-
            Optional idempotency key for safely retrying the same outgoing
            transfer request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferOutMvpRequest'
            examples:
              customerPayout:
                value:
                  customerId: 019542f5-b3e7-1d02-0000-000000000001
                  source:
                    accountId: a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
                  destination:
                    accountId: e85dcbd6-dced-4ec4-b756-3c3a9ea3d965
                  amount: 12550
                  description: Customer withdrawal
      responses:
        '201':
          description: Same-currency outgoing payout / withdrawal created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferOutMvpResponse'
              examples:
                created:
                  value:
                    type: OUTGOING
                    status: COMPLETED
                    customerId: 019542f5-b3e7-1d02-0000-000000000001
                    platformCustomerId: partner_cust_9f8b2c7d
                    source:
                      accountId: a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
                    destination:
                      accountId: e85dcbd6-dced-4ec4-b756-3c3a9ea3d965
                    amount: 12550
                    currency: USD
                    description: Customer withdrawal
                    createdAt: '2025-07-21T17:32:28Z'
                    updatedAt: '2025-07-21T17:32:28Z'
                    settledAt: '2025-07-21T17:32:28Z'
                    id: gpid_transfer_out_001
        '400':
          description: Invalid request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferOutMvpErrorResponse'
              examples:
                invalidInput:
                  value:
                    status: 400
                    code: INVALID_REQUEST
                    message: Invalid request body
                    details: {}
        '401':
          description: Invalid or missing API credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferOutMvpErrorResponse'
              examples:
                unauthorized:
                  value:
                    status: 401
                    code: UNAUTHORIZED
                    message: Invalid or missing API credentials
                    details: {}
        '404':
          description: Customer or account not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferOutMvpErrorResponse'
              examples:
                customerOrAccountNotFound:
                  value:
                    status: 404
                    code: NOT_FOUND
                    message: Customer or account not found
                    details: {}
        '409':
          description: >-
            Transfer cannot proceed. Returned for insufficient internal balance,
            same-currency validation failures, or idempotency-key reuse with a
            different payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferOutMvpErrorResponse'
              examples:
                insufficientBalance:
                  value:
                    status: 409
                    code: INSUFFICIENT_BALANCE
                    message: Insufficient internal account balance
                    details: {}
                sameCurrencyMismatch:
                  value:
                    status: 409
                    code: SAME_CURRENCY_MISMATCH
                    message: >-
                      Transfer must use the same currency across source and
                      destination
                    details: {}
                idempotencyConflict:
                  value:
                    status: 409
                    code: IDEMPOTENCY_CONFLICT
                    message: Idempotency-Key reuse with different payload
                    details:
                      method: POST
                      path: /transfer-out
        '500':
          description: Internal service error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferOutMvpErrorResponse'
              examples:
                internalServiceError:
                  value:
                    status: 500
                    code: INTERNAL_ERROR
                    message: Internal service error
                    details: {}
      security:
        - BasicAuth: []
components:
  schemas:
    TransferOutMvpRequest:
      type: object
      additionalProperties: false
      required:
        - customerId
        - source
        - destination
        - amount
      properties:
        customerId:
          type: string
          description: >-
            BLIPS customer UUID that owns the internal source account and bound
            external destination account.
        source:
          $ref: '#/components/schemas/TransferOutMvpAccountRef'
          description: >-
            Customer internal source account that funds the same-currency
            outgoing payout.
        destination:
          $ref: '#/components/schemas/TransferOutMvpAccountRef'
          description: >-
            Bound external destination account that receives the same-currency
            payout.
        amount:
          type: integer
          minimum: 1
          description: Outgoing payout or withdrawal amount in minor units.
        description:
          type: string
          description: Optional payout description stored with the transfer.
    TransferOutMvpResponse:
      type: object
      additionalProperties: false
      required:
        - id
        - type
        - status
        - customerId
        - platformCustomerId
        - source
        - destination
        - amount
        - currency
        - description
        - createdAt
        - updatedAt
        - settledAt
      properties:
        id:
          type: string
          description: >-
            Public identifier for the created same-currency outgoing payout or
            withdrawal.
        type:
          type: string
          enum:
            - OUTGOING
          description: Same-currency outgoing transfer type for this endpoint.
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - COMPLETED
            - FAILED
          description: Current same-currency outgoing payout or withdrawal status.
        customerId:
          type: string
          description: BLIPS customer UUID that owns the transfer.
        platformCustomerId:
          type: string
          description: Platform-side customer identifier echoed from the bound customer.
        source:
          $ref: '#/components/schemas/TransferOutMvpAccountRef'
          description: Customer internal source account.
        destination:
          $ref: '#/components/schemas/TransferOutMvpAccountRef'
          description: Bound external destination account.
        amount:
          type: integer
          minimum: 1
          description: Same-currency transfer amount in minor units.
        currency:
          type: string
          description: >-
            ISO 4217 currency code shared by the source and destination
            accounts.
        description:
          type: string
          nullable: true
          description: >-
            Optional payout description echoed from the create request when
            present.
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp.
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp.
        settledAt:
          type: string
          format: date-time
          nullable: true
          description: Settlement timestamp when the outgoing payout has completed.
    TransferOutMvpErrorResponse:
      type: object
      additionalProperties: false
      required:
        - status
        - code
        - message
        - details
      properties:
        status:
          type: integer
          enum:
            - 400
            - 401
            - 404
            - 409
            - 500
          description: HTTP status code for the failed transfer-out request.
        code:
          type: string
          description: Stable public error code for the failed transfer-out request.
        message:
          type: string
          description: Human-readable summary of why the transfer-out request failed.
        details:
          type: object
          additionalProperties: true
          nullable: true
          description: >-
            Optional machine-readable error details when additional context is
            available.
    TransferOutMvpAccountRef:
      type: object
      additionalProperties: false
      required:
        - accountId
      properties:
        accountId:
          type: string
          description: Stable BLIPS account identifier.
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Integration-key Basic Auth (`clientId:clientSecret`) as documented in
        docs/public/AUTHENTICATION.md.

````