/merchant/invoices/:id/payoutsList Invoice Payouts
getMerchantInvoicesPayoutsByIdV2https://a-api.coinpayments.net/api/v2/merchant/invoices/:id/payoutsRequest
path parametersidstringpathInvoice id
Responses
200 · 401 · 403Represents information about a payouts to a Merchant
hashstringnullableTxHash from the blockchain if the transaction is an external transaction.
displayValuestringnullablethe value formatted for display
valuestringnullablethe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500.
31000currencyIdstringnullablethe currency the monetary `value` is represented in
1235valueAsDecimalnumberRepresents the monetary value as a decimal, allowing for precise calculations and storage.
doubleconversionIdintegernullableRepresents the unique identifier for a currency conversion associated with the transaction, if the transaction involves a currency conversion process.
int64paidDatestringnullableThe date and time when the payment was made.
date-timecompletedTxIdstringnullableThe ID of the completed transaction.
externalAddressstringnullableThe external address where the payout is deposited
destinationCurrencyIdstringnullableThe currency ID of the destination for the payout
expectedDisplayValuestringnullableThe expected display value of the payout.
sourceCurrencyIdstringnullableThe currency ID of the source for the payout
destinationWalletIdstringnullableThe ID of the destination wallet for the payout
isConversionbooleanIndicates whether a currency conversion is involved in the payout
conversionProgressnumbernullableThe progress status of the currency conversion
doublesettlementModeErrorCodeintegernullableRepresents the error code related to settlement mode in case of payout processing failures. This property provides additional information regarding the type of error encountered.
int32displayValuestringnullablethe value formatted for display
valuestringnullablethe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500.
31000currencyIdstringnullablethe currency the monetary `value` is represented in
1235valueAsDecimalnumberRepresents the monetary value as a decimal, allowing for precise calculations and storage.
doubledisplayValuestringnullablethe value formatted for display
valuestringnullablethe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500.
31000currencyIdstringnullablethe currency the monetary `value` is represented in
1235valueAsDecimalnumberRepresents the monetary value as a decimal, allowing for precise calculations and storage.
doublereceivedBlockchainTxIdstringnullableThe blockchain transaction ID associated with the received payment for the invoice payout.
idstringthe unique id of the currency on the CoinPayments platform
1235typestringType of currency
cryptotokenfiatsymbolstringticker symbol for the currency. For fiat currencies this is the three character (ISO-4217) currency code, and for crypto currencies their multi-character symbol.
BTCnamestringthe name of the currency, e.g. 'United States Dollar' or 'Bitcoin'
BitcoinimageUrlstringnullableLink to a CoinPayments hosted image for a currency in a SVG format
decimalPlacesintegerthe number of digits after the decimal separator, e.g. 2 for USD, 8 for BTC, 0 for JPY
int32rankintegerthe relative ordering/ranking of this currency to the other supported currencies on the CoinPayments platform
int32statusstringThe status of the currency on the CoinPayments platform
activeunderMaintenancedeletedcapabilitiesstring[]nullablethe capabilities of the currency on the CoinPayments platform
paymentssingleSigAccountspooledAccountsutxoconversiononRampoffRampwebsitesstring[]nullablethe websites for the currency
explorersstring[]nullablethe explorers for the currency (if crypto or a token)
requiredConfirmationsintegerThe required number of confirmations needed to be received to treat transactions related to this currency as confirmed
int64isEnabledForPaymentbooleanWhether currency is enabled as a payment option for invoices and payment buttons
currencyIdstringthe currency the monetary `value` is represented in
1235displayValuestringnullablethe value formatted for display
valuestringthe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500. if no value provided default is 0.
31000valueAsDecimalnumberRepresents the monetary value converted to a decimal type.
doublecurrencyIdstringthe currency the monetary `value` is represented in
1235displayValuestringnullablethe value formatted for display
valuestringthe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500. if no value provided default is 0.
31000valueAsDecimalnumberRepresents the monetary value converted to a decimal type.
doublecurrencyIdstringthe currency the monetary `value` is represented in
1235displayValuestringnullablethe value formatted for display
valuestringthe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500. if no value provided default is 0.
31000valueAsDecimalnumberRepresents the monetary value converted to a decimal type.
doublecurrencyIdstringthe currency the monetary `value` is represented in
1235displayValuestringnullablethe value formatted for display
valuestringthe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500. if no value provided default is 0.
31000valueAsDecimalnumberRepresents the monetary value converted to a decimal type.
doublecurrencyIdstringthe currency the monetary `value` is represented in
1235displayValuestringnullablethe value formatted for display
valuestringthe amount of money, as an integer, in the currencies base (smallest) monetary unit. For example, Bitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC would have a value of 100000000 and 0.00031 BTC a value of 31000. An amount of $9.99 USD would have the value 999 (i.e, 999 cents). Zero-decimal currencies such as the Yen would represent a value of ¥500 as 500. if no value provided default is 0.
31000valueAsDecimalnumberRepresents the monetary value converted to a decimal type.
doublemerchantPayoutAddressstringthe merchants payment output address at the time the hot wallet was created
createdstringthe timestamp of when this payout was created (or scheduled)
date-timesentstringnullablethe timestamp of when this payout was sent (e.g. broadcast on the blockchain)
date-timeexpectedstringnullablethe approximate timestamp of when this payout is expected to be sent (e.g. broadcast on the blockchain)
date-timeconfirmedstringnullablethe timestamp of when this payout was confirmed (e.g. on the blockchain)
date-timestatestringscheduledsendingsentconfirmedwaitingConversionfailedwaitingInternalReceivewaitingExternalConfirmbeforestringnullableafterstringnullablelimitintegerint32firststringnullableurinextstringnullableuripreviousstringnullableurilaststringnullableuri