---
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.

## Headers

- `Idempotency-Key` string

## Request body

- CreatePayoutDto
  - `amount` number, required — The payout amount in decimal format. The minimum amount is 0.01.
  - `currency` 'EUR' | 'GBP' | 'USDC' | 'USD', required
  - `destination` object, required
    - `type` 'beneficiary' | 'customer' — Beneficiary is a payout to an account owned by the merchant. Customer is a payout to an external customer account.
    - `orderId` string
    - `financialAddress` object, nullable
      - `type` 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba', required
      - `iban` object
        - `accountHolderName` string, required
        - `iban` string, required
        - `bic` string
      - `aba` object
        - `accountHolderName` string, required
        - `routingNumber` string, required
        - `accountNumber` string, required
      - `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
        - `blockchain` 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY', required — The blockchain network
    - `address` object — Physical postal address of the payout counterparty.
      - `line1` string — Primary street address line.
      - `line2` string — Secondary street address line.
      - `city` string, required — City or locality.
      - `postalCode` string — Postal or ZIP code.
      - `state` string — State, province, or region.
      - `countryCode` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK', required — ISO 3166-1 alpha-2 country code.
  - `rail` 'SEPA_INSTANT' | 'FASTER_PAYMENTS' | 'SEPA' | 'ELIXIR' | 'EXPRESS_ELIXIR' | 'SEK_ACCOUNT_TO_ACCOUNT' | 'SUMCLEARING' | 'STRAKSCLEARING' | 'SWIFT' | 'INTERNAL' | 'TARGET' | 'ACH' | 'FEDWIRE' | 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY' — The payment rail or blockchain used for the payout
  - `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' | 'aba', required
    - `iban` object
      - `accountHolderName` string, required
      - `iban` string, required
      - `bic` string
    - `aba` object
      - `accountHolderName` string, required
      - `routingNumber` string, required
      - `accountNumber` string, required
    - `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
      - `blockchain` 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY', required — The blockchain network
  - `status` 'paid' | 'pending' | 'in_transit' | 'failed' | 'canceled', required — The payout status
  - `amount` number, required — The payout amount
  - `currency` 'EUR' | 'GBP' | 'USDC' | 'USD', 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
  - `failure` object — Failure details. Only available if the payout failed.
    - `code` 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown', required — Failure code. Please refer to the documentation for the list of possible values.
    - `message` string, required — Human readable description of the failure.
    - `retry` boolean, required — If true, you can safely retry.

---

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