COconfirmo
Payout

Change status of a Payout.

Changes status of payout depending on action provided in request. Note that without opting-in to the new payouts flow, using other actions than CONFIRM and CANCEL will result into an error.

patch/v3/payouts/{id}

Request

  • Base URL
    https://confirmo.net/api
  • URL
    https://confirmo.net/api/v3/payouts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The Payout ID.

Request body

action'PREPARE' | 'CONFIRM' | 'CANCEL' required

Action to be performed.

Example request

{
  "action": "CONFIRM"
}

Response

OK

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.