--- title: "Create a new Payout" method: POST path: "/v3/payouts" tags: ["Payout"] --- # Create a new Payout `POST /v3/payouts` ## Request - Base URL: `https://confirmo.net/api` - URL: `https://confirmo.net/api/v3/payouts` - Auth: HTTP bearer Creates a new Payout request to transfer funds from merchant account to a specified address. ## Request body - CreatePayoutRequest - `address` string - `amountFrom` number: Either this or amountTo must be present. - `amountTo` number: Either this or amountFrom must be present. - `btcPriority` 'LOW' | 'MEDIUM' | 'HIGH': If present, the priority value is used only for payment methods which support priority settings (currently only BITCOIN_BLOCKCHAIN_MAINNET_BTC, legacy code BITCOIN_BTC). If not present, HIGH is used by default for payment methods which support it (currently only BITCOIN_BLOCKCHAIN_MAINNET_BTC, legacy code BITCOIN_BTC). For other methods, the automatically resolved value is used and the set value is ignored. - `currencyFrom` 'BTC' | 'CZK' | 'EUR' | 'USD' | 'USDC' | 'USDT', required: Balance of this asset is affected by the payout. - `currencyTo` 'BTC' | 'LTC': Superseded by paymentMethodId. Should not be used anymore. - `customerEmail` string, email: The email address to which email notifications for the customer will be sent. - `customerProfile` union: Optional customer profile details to attach to the payout. - CompanyProfileTo - `city` string: City of the customer's address. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW': Country of the customer's address, represented as a two-letter ISO 3166-1 alpha-2 country code. - `postalCode` string: Postal or ZIP code of the customer's address. - `profileId` string, required: Merchant's identifier of the customer profile. - `streetAddress` string: Street portion of the customer's address. - `type` 'individual' | 'company' | 'reference': Customer profile type. - `lei` string: Legal Entity Identifier of the company (ISO 17442): 20 upper-case alphanumeric characters ending with two check digits. - `registeredName` string: Registered company name. - `registrationNumber` string: Company registration number. - IndividualProfileTo - `city` string: City of the customer's address. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW': Country of the customer's address, represented as a two-letter ISO 3166-1 alpha-2 country code. - `postalCode` string: Postal or ZIP code of the customer's address. - `profileId` string, required: Merchant's identifier of the customer profile. - `streetAddress` string: Street portion of the customer's address. - `type` 'individual' | 'company' | 'reference': Customer profile type. - `dateOfBirth` string: Date of birth for the customer (YYYY-MM-DD). - `firstName` string: First name of the individual customer. - `lastName` string: Last name of the individual customer. - `middleName` string: Middle name of the individual customer. - `nationalIdNumber` string: Number of the customer's official identity document, such as a passport or national identity card. - `placeOfBirth` string: Place of birth for the customer. - ReferenceProfileTo - `city` string: City of the customer's address. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW': Country of the customer's address, represented as a two-letter ISO 3166-1 alpha-2 country code. - `postalCode` string: Postal or ZIP code of the customer's address. - `profileId` string, required: Merchant's identifier of the customer profile. - `streetAddress` string: Street portion of the customer's address. - `type` 'individual' | 'company' | 'reference': Customer profile type. - `feePaymentMode` 'MERCHANT' | 'RECIPIENT' | 'NETWORK_FEE_RECIPIENT': If provided, this value takes precedence over treatAsGrossAmount. MERCHANT - debited amount is increased by the total fee. RECIPIENT - debited amount remains same but the recipient received amount decreased by the total fee. NETWORK_FEE_RECIPIENT - debited amount is increased by the processing fee and recipient received amount decreased only by the network fee. - `isDraft` boolean: Value that indicates whether draft or a regular payout should be created. Default value is false. Note that without opting-in to the new payout flow, setting this flag explicitly to true will result into an client side error. - `notifyEmail` string, email: E-mail where payout notifications will be sent. - `notifyUrl` string, url: Webhook URL where payout webhooks will be sent. - `paymentMethodId` string: Supersedes deprecated parameter 'currencyTo'. Valid values are the 'id' values returned by GET /api/v3/crypto-payment-methods. - `reference` string: Any data the merchant wishes to store in the payout. It might be, for instance, a JSON or any other string identifying the payout in the merchant's system. The maximum length is 512 characters. - `treatAsGrossAmount` boolean: The total fee (processing and network) will be deducted from the requested amount. The 'null' value is equivalent to 'false' value - the fee is not deducted from requested amount, and is deducted from the balance. ## Response `201` Payout successfully created - PayoutToV3 - `address` string - `amountFrom` number - `amountTo` number - `btcPriority` 'LOW' | 'MEDIUM' | 'HIGH': Valid only for the payment method for native BTC. For BTC transactions, HIGH is default. - `completedAt` integer - `createdAt` integer - `currencyFrom` 'BTC' | 'CZK' | 'EUR' | 'USD' | 'USDC' | 'USDT': Balance of this asset is affected by the payout. - `currencyTo` 'BNB' | 'BTC' | 'ETH' | 'EURC' | 'LTC' | 'POL' | 'SOL' | 'TRX' | 'USAT' | 'USDC' | 'USDG' | 'USDT' | 'XPL': Superseded by paymentMethodId. - `customerEmail` string: The email address to which email notifications for the customer will be sent. - `customerProfile` CustomerProfileReferenceTo: Customer profile reference - `profileId` string: Merchant's identifier of the customer profile. - `debitedAmount` number: The debited amount (in currencyFrom asset) from merchant balance. - `exchangeRate` number: Price of one crypto in source asset. - `expiration` integer - `fee` number - `feeCurrency` string: The same asset code as currencyFrom. - `feePaymentMode` 'MERCHANT' | 'RECIPIENT' | 'NETWORK_FEE_RECIPIENT' - `id` string - `layer2Attributes` LightningLayerAttributesTo - `protocolName` 'LIGHTNING' | 'POLYGON' | 'ARBITRUM' | 'OPTIMISM': Layer 2 protocol name. - `bolt` string - `lnurl` string - `paymentHash` string - `notifyEmail` string: E-mail where payout notifications will be sent. - `notifyUrl` string, url: Webhook URL where payout webhooks will be sent. - `paymentMethodId` string - `reference` string: Any data the merchant wishes to store in the payout. It might be, for instance, a JSON or any other string identifying the payout in the merchant's system. The maximum length is 512 characters. - `sentAt` integer - `sourceAddresses` string[] - `status` string: Indicates the state of the payout. See the statuses section in the documentation for all possible values. - `substatus` string: Set on a `canceled` payout when the reason is one the catalogue names (`screening_rejected`, `verification_rejected`, `manually_canceled`). Not every cancellation has a reason to report, so its absence is not itself information. The one non-terminal value is `compliance_hold`: the payout is held in `confirmed` for an extended review while funds stay reserved — substatus changes never fire webhooks, so re-query the payout if it stays `confirmed` unusually long. Treat this as an open set: new values are added as they are announced, and your integration must tolerate ones it does not recognise. - `treatAsGrossAmount` boolean: The total fee (processing and network) was deducted from the requested amount. - `txid` string - `url` string, uri: The URL of the Payout's public view for the customers. - `validTo` integer: The time until which the transaction is valid to. After this time the transaction is not registered. ## Other responses - `400`: Bad Request - `403`: Forbidden - `409`: Conflict --- [API](https://skmtc.dev/confirmo/apis/confirmo-api.md) - [All operations](https://skmtc.dev/confirmo/apis/confirmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/confirmo/apis/confirmo-api/revisions/09bef7db3dd1?raw)