---
title: "Create a payout"
method: POST
path: "/api/service/payout/create"
tags: ["Payout"]
---

# Create a payout

`POST /api/service/payout/create`

Create a payout for a merchant.

## Request body

- CreatePayoutDto
  - `amount` number, required — The payout amount in decimal format. The minimum amount is 0.01.
  - `currency` 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK', required — The payout currency
  - `destination` object, required — The payout destination
    - `type` 'beneficiary'
    - `orderId` string
    - `financialAddress` object, nullable
      - `type` 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet', required
      - `iban` object
        - `accountHolderName` string, required
        - `iban` string, required
        - `bic` string
      - `sortCode` object
        - `accountHolderName` string, required
        - `sortCode` string, required
        - `accountNumber` string, required
      - `bankCode` object
        - `accountHolderName` string, required
        - `code` string, required
        - `accountNumber` string, required
      - `bban` object
        - `accountHolderName` string, required
        - `bban` string, required
        - `bic` string
      - `wallet` object
        - `address` string, required — The blockchain wallet address
  - `metadata` object — This can be used to store any additional information you need to associate with this payout.
  - `paymentReference` string — The payout payment reference. This is visible to the receiving party, if possible.

## Response `200`

Create a payout

- CreatePayoutResponseDto
  - `id` string, required — The payout ID
  - `type` 'beneficiary' | 'customer', required — The payout type
  - `destination` object, required — The payout destination
    - `type` 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet', required
    - `iban` object
      - `accountHolderName` string, required
      - `iban` string, required
      - `bic` string
    - `sortCode` object
      - `accountHolderName` string, required
      - `sortCode` string, required
      - `accountNumber` string, required
    - `bankCode` object
      - `accountHolderName` string, required
      - `code` string, required
      - `accountNumber` string, required
    - `bban` object
      - `accountHolderName` string, required
      - `bban` string, required
      - `bic` string
    - `wallet` object
      - `address` string, required — The blockchain wallet address
  - `status` 'paid' | 'pending' | 'in_transit' | 'failed' | 'canceled', required — The payout status
  - `amount` number, required — The payout amount
  - `currency` 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK', required — The payout currency
  - `metadata` object — The payout metadata
  - `createdAt` unknown, required
  - `updatedAt` unknown, required
  - `paymentReference` string — The payout payment reference
  - `transactionId` string — The payout transaction ID

## Changes

- **2025-10-17** `102fab1c7e1a` — 1 warning, 3 info
  - added the new `wallet` enum value to the `destination/type` response property for the response status `200`
  - added the new optional request property `destination/financialAddress/wallet`
  - added the new `wallet` enum value to the request property `destination/financialAddress/type`
  - added the optional property `destination/wallet` to the response with the `200` status

[Change history](https://skmtc.dev/augustus/apis/ivy-api/changes/api/service/payout/create/post.md)

---

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