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

# Mock Payout

> Mock a payout of available balance. Sandbox only.

This endpoint mocks a payout so you can test `payout.created` webhooks and list charges. It is sandbox only. Production returns 404.


## OpenAPI

````yaml post /v1/payouts
openapi: 3.1.1
info:
  title: HitPay API
  description: >-
    Accept PayNow, FPX, QRIS, GrabPay, cards, and 40+ payment methods with a
    single API. Production base URL: https://api.hit-pay.com, Sandbox:
    https://api.sandbox.hit-pay.com
  version: '1.0'
servers:
  - url: https://api.hit-pay.com
    description: Production
  - url: https://api.sandbox.hit-pay.com
    description: Sandbox
security: []
paths:
  /v1/payouts:
    post:
      tags:
        - Payouts
      summary: Mock a payout
      description: >-
        Mocks a payout of the available balance so you can test `payout.created`
        webhooks and list charges on a payout. This is not a production payout.
        Sandbox only. Returns 404 in production.
      operationId: mock-payout
      parameters:
        - name: X-BUSINESS-API-KEY
          in: header
          required: true
          style: simple
          explode: false
          schema:
            type: string
            example: b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                currency:
                  type: string
                  description: >-
                    Wallet currency to pay out. Defaults to the business home
                    currency.
                  example: sgd
      responses:
        '201':
          description: Payout created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payout'
              examples:
                Result:
                  value:
                    id: 9e10fcd2-f657-489b-947e-1383790b53bf
                    status: scheduled
                    currency: sgd
                    amount: 15000
                    source_currency: sgd
                    source_amount: 15000
                    bank_name: DBS Bank
                    bank_account: •••1234
                    remark: null
                    reference: null
                    arrival_date: null
                    created_at: '2026-09-17T14:18:42+08:00'
                    updated_at: '2026-09-17T14:18:42+08:00'
        '404':
          description: Not available in production
      deprecated: false
components:
  schemas:
    Payout:
      type: object
      description: >-
        Settlement of the business's available balance to its linked bank
        account.
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - scheduled
            - processing
            - paid
            - failed
            - canceled
            - pending
        currency:
          type: string
          example: sgd
        amount:
          type: number
          description: Payout amount in major units
        source_currency:
          type: string
          example: sgd
        source_amount:
          type: number
        bank_name:
          type: string
          nullable: true
        bank_account:
          type: string
          nullable: true
          description: Masked bank account number
        remark:
          type: string
          nullable: true
        reference:
          type: string
          nullable: true
        failure_code:
          type: string
          nullable: true
          description: Present when status is failed
        failure_message:
          type: string
          nullable: true
        arrival_date:
          type: string
          format: date
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - status
        - currency
        - amount
        - source_currency
        - source_amount
        - created_at
        - updated_at

````