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

> ## Agent Instructions
> Treat the published Augustus OpenAPI specification (https://api.augustus.com/openapi/2026-05-01.json) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers.
> Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate surface covering the Pay by Bank products — Instant Bank Transfer (Open Banking) checkout and refunds, and Manual Bank Transfer (MBT); use it when one of those products is required.
> Cite or link the relevant docs.augustus.com page when answering integration questions.
> Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation.
> Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key.
> The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions.

# user_payout.initiated

> A customer payout has been initiated



## OpenAPI

````yaml https://api.augustus.com/openapi/webhooks/json post /api/service/webhook-event/user_payout.initiated
openapi: 3.0.0
info:
  title: Ivy Webhook Events
  description: Ivy Webhook Events schema
  version: '1.0'
  contact:
    name: Ivy
    url: https://www.getivy.io
    email: help@getivy.io
servers: []
security: []
tags: []
paths:
  /api/service/webhook-event/user_payout.initiated:
    post:
      tags:
        - WebhookEventExamples
        - Deprecated
      summary: user_payout.initiated
      description: A customer payout has been initiated
      operationId: WebhookEventExamplesController_userPayoutInitiated
      parameters: []
      requestBody:
        required: true
        description: Data of the webhook event
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPayoutInitiatedWebhookEventDto'
      responses:
        '200':
          description: OK
      deprecated: true
      servers:
        - url: https://{yourDomain}
          variables:
            yourDomain:
              description: The URL where you want to receive webhook events
              default: www.your-domain.com
components:
  schemas:
    UserPayoutInitiatedWebhookEventDto:
      type: object
      properties:
        id:
          type: string
          description: The unique id for the webhook.
        type:
          type: string
          enum:
            - user_payout.initiated
        date:
          type: string
          description: The date of the webhook.
        payload:
          type: object
          properties:
            id:
              type: string
              description: The payout ID
            type:
              type: string
              enum:
                - beneficiary
                - customer
              description: The payout type
            destination:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - iban
                    - sort_code
                    - bank_code
                    - bban
                    - wallet
                    - aba
                    - bic
                iban:
                  type: object
                  properties:
                    accountHolderName:
                      type: string
                      minLength: 1
                    iban:
                      type: string
                    bic:
                      type: string
                  required:
                    - accountHolderName
                    - iban
                aba:
                  type: object
                  properties:
                    accountHolderName:
                      type: string
                      minLength: 1
                    routingNumber:
                      type: string
                      minLength: 9
                      maxLength: 9
                      pattern: ^[0-9]+$
                    accountNumber:
                      type: string
                      pattern: ^[0-9]+$
                  required:
                    - accountHolderName
                    - routingNumber
                    - accountNumber
                bic:
                  type: object
                  properties:
                    accountHolderName:
                      type: string
                      minLength: 1
                    accountNumber:
                      type: string
                    bic:
                      type: string
                    localBankCode:
                      type: string
                  required:
                    - accountHolderName
                    - accountNumber
                    - bic
                sortCode:
                  type: object
                  properties:
                    accountHolderName:
                      type: string
                      minLength: 1
                    sortCode:
                      type: string
                      minLength: 6
                      maxLength: 6
                      pattern: ^[0-9]+$
                    accountNumber:
                      type: string
                      maxLength: 8
                      pattern: ^[0-9]+$
                  required:
                    - accountHolderName
                    - sortCode
                    - accountNumber
                bankCode:
                  type: object
                  properties:
                    accountHolderName:
                      type: string
                      minLength: 1
                    code:
                      type: string
                    accountNumber:
                      type: string
                  required:
                    - accountHolderName
                    - code
                    - accountNumber
                bban:
                  type: object
                  properties:
                    accountHolderName:
                      type: string
                      minLength: 1
                    bban:
                      type: string
                    bic:
                      type: string
                  required:
                    - accountHolderName
                    - bban
                wallet:
                  type: object
                  properties:
                    address:
                      type: string
                      description: The blockchain wallet address
                    blockchain:
                      type: string
                      enum:
                        - BTC
                        - BTC-TESTNET4
                        - ETH
                        - ETH-SEPOLIA
                        - SOL
                        - SOL-DEVNET
                        - MATIC
                        - MATIC-AMOY
                      description: The blockchain network
                  required:
                    - address
                    - blockchain
              required:
                - type
              description: The payout destination
            status:
              type: string
              enum:
                - paid
                - pending
                - in_transit
                - failed
                - returned
                - canceled
              description: The payout status
            amount:
              type: number
              description: The payout amount
            currency:
              type: string
              enum:
                - EUR
                - GBP
                - USDC
                - USD
              description: The payout currency
            metadata:
              description: The payout metadata
              type: object
              additionalProperties: {}
            createdAt:
              type: string
              format: date-time
              description: The payout created at
            updatedAt:
              type: string
              format: date-time
              description: The payout updated at
            paymentReference:
              description: The payout payment reference
              type: string
            transactionId:
              description: The payout transaction ID
              type: string
            failure:
              type: object
              properties:
                code:
                  type: string
                  enum:
                    - account_closed
                    - account_blocked
                    - insufficient_funds
                    - invalid_account_format
                    - invalid_routing_number
                    - invalid_instruction
                    - invalid_amount
                    - invalid_time
                    - duplicate_transaction
                    - payee_verification_failed
                    - return_not_possible
                    - system_error
                    - provider_system_error
                    - rejected_by_correspondent_bank
                    - blocked_by_review
                    - unknown
                  description: >-
                    Failure code. Please refer to the documentation for the list
                    of possible values.
                message:
                  type: string
                  description: Human readable description of the failure.
                retry:
                  type: boolean
                  description: If true, you can safely retry.
              required:
                - code
                - message
                - retry
              description: Failure details. Only available if the payout failed.
          required:
            - id
            - type
            - destination
            - status
            - amount
            - currency
            - createdAt
            - updatedAt
          description: The initiated user payout data.
      required:
        - id
        - type
        - date
        - payload

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.