Create a new Payout

post

https://confirmo.net/api/v3/payouts

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

address

string

length between 26 and 140

amountFrom

number

Either this or amountTo must be present.

amountTo

number

Either this or amountFrom must be present.

btcPriority

string

enum

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.

Allowed:

currencyFrom

string

enum

required

Balance of this asset is affected by the payout.

Allowed:

currencyTo

string

enum

deprecated

Superseded by paymentMethodId. Should not be used anymore.

Allowed:

customerEmail

string

length between 0 and 254

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

customerProfile

Optional customer profile details to attach to the payout.

feePaymentMode

string

enum

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.

Allowed:

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

length between 0 and 254

E-mail where payout notifications will be sent.

notifyUrl

url

length between 0 and 512

Webhook URL where payout webhooks will be sent.

paymentMethodId

string

Supersedes deprecated parameter 'currencyTo'.

reference

string

length between 0 and 512

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Payout successfully created

400Bad Request

403Forbidden

409Conflict