Payout

Create a new Payout

Creates a new Payout request to transfer funds from merchant account to a specified address.

post/v3/payouts

Request

Base URL
https://confirmo.net/api
URL
https://confirmo.net/api/v3/payouts
Auth
HTTP bearer

Request body

addressstring

amountFromnumber

Either this or amountTo must be present.

amountTonumber

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.

customerEmailstring email

The email address to which email notifications for the customer will be sent.

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.

isDraftboolean

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.

notifyEmailstring email

E-mail where payout notifications will be sent.

notifyUrlstring url

Webhook URL where payout webhooks will be sent.

paymentMethodIdstring

Supersedes deprecated parameter 'currencyTo'. Valid values are the 'id' values returned by GET /api/v3/crypto-payment-methods.

referencestring

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.

treatAsGrossAmountboolean

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.

Example request

{
  "address": "3J98t…NLy",
  "amountFrom": 10,
  "btcPriority": "HIGH",
  "currencyFrom": "EUR",
  "currencyTo": "BTC",
  "customerEmail": "customerEmail@email.com",
  "customerProfile": {
    "city": "Springfield",
    "country": "US",
    "postalCode": "90210",
    "profileId": "profile-12345",
    "streetAddress": "123 Main Street",
    "lei": "5493001KJTIIGC8Y1R12",
    "registeredName": "ACME Inc.",
    "registrationNumber": "12345678"
  },
  "feePaymentMode": "MERCHANT",
  "notifyEmail": "notifyEmail@email.com",
  "notifyUrl": "https://yourEShop.com/payoutProcess",
  "paymentMethodId": "BITCOIN-BLOCKCHAIN-MAINNET-BTC-CURRENCY",
  "treatAsGrossAmount": true
}

Response

Payout successfully created

addressstring

amountFromnumber

amountTonumber

btcPriority'LOW' | 'MEDIUM' | 'HIGH'

Valid only for the payment method for native BTC. For BTC transactions, HIGH is default.

completedAtinteger

createdAtinteger

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.

customerEmailstring

The email address to which email notifications for the customer will be sent.

debitedAmountnumber

The debited amount (in currencyFrom asset) from merchant balance.

exchangeRatenumber

Price of one crypto in source asset.

expirationinteger

feenumber

feeCurrencystring

The same asset code as currencyFrom.

feePaymentMode'MERCHANT' | 'RECIPIENT' | 'NETWORK_FEE_RECIPIENT'

idstring

notifyEmailstring

E-mail where payout notifications will be sent.

notifyUrlstring url

Webhook URL where payout webhooks will be sent.

paymentMethodIdstring

referencestring

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.

sentAtinteger

sourceAddressesstring[]

statusstring

Indicates the state of the payout. See the statuses section in the documentation for all possible values.

substatusstring

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.

treatAsGrossAmountboolean

The total fee (processing and network) was deducted from the requested amount.

txidstring

urlstring uri

The URL of the Payout's public view for the customers.

validTointeger

The time until which the transaction is valid to. After this time the transaction is not registered.

Example response

{
  "address": "3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy",
  "btcPriority": "HIGH",
  "completedAt": 1484056304,
  "createdAt": 1484055304,
  "currencyFrom": "EUR",
  "currencyTo": "BTC",
  "customerEmail": "customerEmail@email.com",
  "customerProfile": {
    "profileId": "profile-12345"
  },
  "debitedAmount": 10,
  "expiration": 1484055424,
  "feeCurrency": "USD",
  "feePaymentMode": "MERCHANT",
  "id": "WDRnwMw9LIF",
  "layer2Attributes": {
    "protocolName": "LIGHTNING"
  },
  "notifyEmail": "customerEmail@email.com",
  "notifyUrl": "https://yourEShop.com/payoutProcess",
  "paymentMethodId": "BITCOIN-BLOCKCHAIN-MAINNET-BTC-CURRENCY",
  "sentAt": 1484055304,
  "sourceAddresses": [
    "6D5a012e39a77800D492420245662406A03e",
    "54SDdf800D492420245662406A03e"
  ],
  "status": "DONE",
  "substatus": "manually_canceled",
  "treatAsGrossAmount": true,
  "txid": "cf3c7…03bcf",
  "url": "https://pay.confirmo.com/public/payout/NOLvQIt2na6kfXBb",
  "validTo": 1484056304
}

Changes

No recorded changes to this operation across all 1 revision of this API.