---
title: "Create a payout page"
method: POST
path: "/v1/payout_pages"
tags: ["Payout Pages"]
---

# Create a payout page

`POST /v1/payout_pages`

## Request body

- CreatePayoutPageRequest — Payout page details
  - `amount` number, required
  - `fundingCurrency` 'USDC' | 'EURC', required
  - `clientReferenceId` string, required
  - `releaseMethod` 'MANUAL' | 'AUTOMATIC', required
  - `customer` union, required
    - object
      - `id` string, required
      - `referenceId` string
      - `email` string, email, required
    - object
      - `id` string
      - `referenceId` string, required
      - `email` string, email, required
  - `successReturnUrl` string
  - `failureReturnUrl` string

## Response `200`

Success

- object — The created payout page
  - `status` 'SUCCEEDED', required
  - `data` CreatePayoutPageResponse, required
    - `id` string, required
    - `status` 'CREATED' | 'PENDING' | 'PROCESSING' | 'PROCESSED' | 'ON_HOLD' | 'REFUNDED' | 'EXPIRED' | 'CANCELLED' | 'REJECTED', required
    - `amount` number, required
    - `fundingCurrency` 'USDC' | 'USDCE' | 'USDBC' | 'USDT' | 'EURC' | 'DAI' | 'BUSD' | 'BTC' | 'ETH' | 'BNB' | 'MATIC' | 'POL' | 'AVAX' | 'SOL' | 'TRX' | 'KAP' | 'ARB' | 'CBBTC' | 'PYUSD' | 'SNS' | 'HONEY', required
    - `payoutDestinationRail` 'ach' | 'sepa' | 'card_usd' | 'zengin' | 'hkd_fps' | 'krw_kftc'
    - `clientReferenceId` string, required
    - `releaseMethod` 'MANUAL' | 'AUTOMATIC', required
    - `merchant` object, required
      - `id` string, required
      - `livemode` boolean, required
    - `customer` object, required
      - `id` string
      - `referenceId` string
      - `email` string, required
    - `successReturnUrl` string
    - `failureReturnUrl` string
    - `url` string, required
    - `pendingStatus` 'PENDING_USER_CONFIRMATION' | 'PENDING_USER_ONBOARDING' | 'PENDING_MERCHANT_RELEASE'
    - `payoutMethod` 'BANK_ACCOUNT' | 'CRYPTO_WALLET' | 'CARD'
    - `customerConfirmedAt` number
    - `processedAt` number
    - `refundedAt` number
    - `resultCode` string
    - `resultMessage` string
    - `cardLast4` string — Please contact our integration team to enable this.
    - `bankAccountLast4` string — Please contact our integration team to enable this.

## Other responses

- `400` — Bad request
- `401` — Unauthorized

---

[API](https://skmtc.dev/breeze/apis/breeze-api.md) · [All operations](https://skmtc.dev/breeze/apis/breeze-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/breeze/breeze-api/revisions/8911892bdf29/schema)