Parameters:
diff --git a/docs/RESTv2.html b/docs/RESTv2.html index 7548434..56d4379 100644 --- a/docs/RESTv2.html +++ b/docs/RESTv2.html @@ -29,7 +29,7 @@ -
Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -526,7 +526,7 @@ accountFee
accountFee
Source:
account
Source:
accountT
Source:
activeOrd
Source:
ac
Source:
addPulseSource:
addPul
Source:
alertDelet
Source:
alertListSource:
alertSetSource:
c
Source:
Source:
can
Source:
cancelOrde
Source:
cance
Source:
cancelOrd
Source:
can
Source:
candlesSource:
changeLogs<
Source:
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
accountT
Source:
activeOrd
Source:
ac
Source:
addPulseSource:
addPul
Source:
alertDelet
Source:
alertListSource:
alertSetSource:
c
Source:
Source:
can
Source:
cancelOrde
Source:
cance
Source:
cancelOrd
Source:
can
Source:
candlesSource:
changeLogs<
Source:
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
ac
Source:
addPulseSource:
addPul
Source:
alertDelet
Source:
alertListSource:
alertSetSource:
c
Source:
Source:
can
Source:
cancelOrde
Source:
cance
Source:
cancelOrd
Source:
can
Source:
candlesSource:
changeLogs<
Source:
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
addPul
Source:
alertDelet
Source:
alertListSource:
alertSetSource:
c
Source:
Source:
can
Source:
cancelOrde
Source:
cance
Source:
cancelOrd
Source:
can
Source:
candlesSource:
changeLogs<
Source:
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
alertListSource:
alertSetSource:
c
Source:
Source:
can
Source:
cancelOrde
Source:
cance
Source:
cancelOrd
Source:
can
Source:
candlesSource:
changeLogs<
Source:
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
alertSetSource:
c
Source:
Source:
can
Source:
cancelOrde
Source:
cance
Source:
cancelOrd
Source:
can
Source:
candlesSource:
changeLogs<
Source:
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
Source:
can
Source:
cancelOrde
Source:
cance
Source:
cancelOrd
Source:
can
Source:
candlesSource:
changeLogs<
Source:
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
cancelOrde
Source:
cance
Source:
cancelOrd
Source:
can
Source:
candlesSource:
changeLogs<
Source:
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
cancelOrd
Source:
can
Source:
candlesSource:
changeLogs<
Source:
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
candlesSource:
changeLogs<
Source:
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
claimPos
Source:
closeFund
Source:
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
closePos
Source:
confSource:
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
(async) cur
Source:
deletePuls
Source:
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
deleteS
Source:
<
Source:
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
(async) e
Source:
fet
Source:
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
f
Source:
funding
Source:
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
fundingInf
Source:
fun
Source:
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
fundingLo
Source:
fu
Source:
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
fundingO
Source:
fundingT
Source:
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
futuresSource:
genera
Source:
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
generate
Source:
getCor
Source:
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
getD
Source:
getSetting
Source:
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
inacti
Source:
in
Source:
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
keepFundin
Source:
keyPerm
Source:
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
ledgersSource:
liquidati
Source:
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
lnx
Source:
loginsSource:
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
marginInfo<
Source:
mar
Source:
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
movementI
Source:
movementsSource:
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
orderBookSource:
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
@@ -18654,6 +18672,12 @@ Properties
+
+
+ null
+
+
+
legacy callback
@@ -18707,7 +18731,7 @@ Returns:
- payDepositsUnlinked(params, cbopt) → {Promise}
+ payCurrencyList(parameters, cbopt) → {Promise}
@@ -18719,7 +18743,7 @@ pa
Source:
pa
-
- See:
-
-
-
@@ -18802,7 +18819,7 @@ Parameters:
- paramsparameters
@@ -18826,41 +18843,20 @@ Parameters:
- query parameters
- Properties
-
+ list of feedbacks
-
-
-
-
- Name
-
+
- Type
+
+
+ params.detailedAttributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ccy
-
-
-string
+
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties
- pay currency to search deposits for
detailed
- startparams.id
-number
+string
@@ -18900,43 +18896,9 @@ Properties
- <optional>
-
-
-
-
-
-
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present
-otherwise it will be yesterday. Min value is 1614758400000
-
-
-
-
-
- end
-
-
-number
-
-
-
-
-
-
-
- <optional>
-
+ <nullable>
@@ -18945,16 +18907,7 @@ Properties
- Millisecond end time, if omitted it will be start + 1 day if start is present
-otherwise it will be current time. Max difference between start and end
-is 2 days!
-
-
-
-
-
-
+ invoice id
Returns:
- payInvoiceComplete(params, cbopt) → {Promise}
+ payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@ pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
+
+
+
- durationcb
-number
+function
@@ -19667,143 +19672,128 @@ Properties
- optional, invoice expire time in seconds, minimal duration
-is 5 mins and maximal duration is 3 days.
-Default value is 15 minutes
legacy callback
+
+
-
-
- orderId
-
-
-string
-
-
-
-
-
-
-
-
-
-
- reference order identifier in merchant's platform
-
-
-
- webhook
-
-
-string
-
-
-
-
-
- <optional>
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- the endpoint that will be called once the payment is
-completed or expired
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
- redirectUrl
-
-
-string
+
+
+
-
-
+
+
-
-
- <optional>
-
-
+
+
+ payInvoiceComplete(params, cbopt) → {Promise}
+
+
-
-
-
-
- merchant redirect URL, this one is used in UI to redirect
-customer to merchant's site once the payment is completed
-or expired
+
+
+
+ - Source:
+
-
- customerInfo- See:
+ -
+
+
+
+
+
+
+
+
+
+
-
-
-
-object
-
-
-
-
-
-
-
-
-
-
- information related to customer against who the invoice
-is issued
- Properties
-
+
+
+
+ Parameters:
+
@@ -19829,13 +19819,13 @@ Properties
- nationalityparams
-string
+object
@@ -19853,15 +19843,35 @@ Properties
- customer's nationality, alpha2 code or full country name
-(alpha2 preffered)
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- residCountryid
@@ -19885,15 +19895,14 @@ Properties
- customer's residential country, alpha2 code or
-full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy
@@ -19908,8 +19917,6 @@ Properties
- <optional>
-
@@ -19919,20 +19926,21 @@ Properties
- optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field
+on invoice
- residCitydepositId
-string
+number
@@ -19941,6 +19949,8 @@ Properties
+ <optional>
+
@@ -19950,20 +19960,20 @@ Properties
- customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds
-string
+Array.<number>
@@ -19972,6 +19982,8 @@ Properties
+ <optional>
+
@@ -19981,20 +19993,20 @@ Properties
- customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- residStreetledgerId
-string
+number
@@ -20003,6 +20015,8 @@ Properties
+ <optional>
+
@@ -20012,20 +20026,28 @@ Properties
- customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId
+or ledgerId
+
+
+
+
+
+
- residBuildingNocb
-string
+function
@@ -20045,114 +20067,131 @@ Properties
- optional, customer's residential building number/name
legacy callback
+
+
-
-
- fullName
-
-
-string
-
-
-
-
-
-
-
-
-
-
- customer's full name
-
-
-
- email
-
-
-string
-
-
-
-
-
-
+Returns:
-
-
-
+
+
+ p
+
-
- customer's email address
-
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
-
+
+
+
-
-
- meta
+
+
-
-object
+
-
-
+ payInvoiceCreate(params, cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- metadata
- Properties
-
+
-
-
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
Name
@@ -20175,7 +20214,59 @@ Properties
- envparams
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
@@ -20190,7 +20281,36 @@ Properties
- <optional>
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
@@ -20201,15 +20321,14 @@ Properties
- merchant environment, allowed values: production, test,
-staging, development
invoice currency
- tagspayCurrencies
@@ -20219,6 +20338,37 @@ Properties
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
@@ -20235,15 +20385,4624 @@ Properties
- invoice tags, max number of tags is 5 and max length of
-tag is 5 characters
optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
-
-
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+customer to merchant's site once the payment is completed
+or expired
+
+
+
+
+
+ customerInfo
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ information related to customer against who the invoice
+is issued
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ nationality
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's nationality, alpha2 code or full country name
+(alpha2 preffered)
+
+
+
+
+
+ residCountry
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential country, alpha2 code or
+full country name (alpha2 preffered)
+
+
+
+
+
+ residState
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential state/province
+
+
+
+
+
+ residCity
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential city/town
+
+
+
+
+
+ residZipCode
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential zip code/postal code
+
+
+
+
+
+ residStreet
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's residential street address
+
+
+
+
+
+ residBuildingNo
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, customer's residential building number/name
+
+
+
+
+
+ fullName
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's full name
+
+
+
+
+
+ email
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ customer's email address
+
+
+
+
+
+ ip
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ customer's ip
+
+
+
+
+
+
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCreatePos(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice amount in currency
+
+
+
+
+
+ currency
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ invoice currency
+
+
+
+
+
+ payCurrencies
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ currencies in which invoice accepts the payments
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ optional, invoice expire time in seconds, minimal duration
+is 5 mins and maximal duration is 3 days.
+Default value is 15 minutes
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ reference order identifier in merchant's platform
+
+
+
+
+
+ webhook
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ the endpoint that will be called once the payment is
+completed or expired
+
+
+
+
+
+ redirectUrl
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant redirect URL, this one is used in UI to redirect
+
+
+
+
+
+ meta
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ metadata
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ env
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ merchant environment, allowed values: production, test,
+staging, development
+
+
+
+
+
+ tags
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice tags, max number of tags is 5 and max length of
+tag is 5 characters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ list of feedbacks
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ detailed
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ detailed
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceEvents(paramsopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice id of which events will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceExpire(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceList(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ start
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond start time
+
+
+
+
+
+ end
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ millisecond end time
+
+
+
+
+
+ limit
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ number of records (Max 100), default 10
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ page
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Current page, default 1 100
+
+
+
+
+
+ pageSize
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Number of records per page, default 10, max 100
+
+
+
+
+
+ sort
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort order, default asc, accepted values are asc and desc
+
+
+
+
+
+ sortField
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+ status
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ invoice status, allowed array item values are:
+CREATED, PENDING, COMPLETED, EXPIRED
+
+
+
+
+
+ fiat
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ fiat filter, should be array of strings
+
+
+
+
+
+ crypto
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ crypto filter, should be array of strings
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ orderId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ erchant order id
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceMarkRefunded(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ refundId
+
+
+string
+
+
+
+
+
+
+
+
+
+ id of the refund
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payInvoiceUpdate(params, cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An object containing the following properties:
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The id property.
+
+
+
+
+
+ fields
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ customerInfo
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ tosAccepted
+
+
+Object
+
+
+
+
+
+
+
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Private note
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantDailyLimit(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the daily limits for merchant
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.customerEmails
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Optional, customer emails for e-commerce usage
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsList(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads multiple merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.keys
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys, if empty array all settings will be returned
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsRead(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Reads merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWrite(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.key
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ params.value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ legacy callback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payMerchantSettingsWriteBatch(cbopt) → {Promise}
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets merchant settings
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params.settings
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Setting keys and values
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting key. Check doc link for possible values
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+ Setting value, if null it means unset
@@ -20335,7 +25094,7 @@ Returns:
- payInvoiceExpire(params, cbopt) → {Promise}
+ payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@ payIn
- Source:
payIn
-
- - See:
- -
-
-
@@ -20454,7 +25206,7 @@ Parameters:
- query parameters
+ list of feedbacks
Properties
@@ -20480,13 +25232,13 @@ Properties
- iddetailed
-string
+boolean
@@ -20496,7 +25248,7 @@ Properties
- unique invoice identifier
detailed
@@ -20588,7 +25340,7 @@ Returns:
- payInvoiceList(paramsopt, cbopt) → {Promise}
+ payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@ payInvo
- Source:
payInvo
-
- - See:
- -
-
-
@@ -20689,7 +25434,7 @@ Parameters:
-object
+Object
@@ -20698,8 +25443,6 @@ Parameters:
- <optional>
-
@@ -20709,7 +25452,7 @@ Parameters:
- query parameters
+ An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@ Properties
Type
- Attributes
-
@@ -20743,126 +25484,161 @@ Properties
-string
+Object
-
-
- <optional>
-
-
-
-
-
-
-
- unique invoice identifier
The id property.
- startfields
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond start time
+ Type
+
+
+
+
+ Description
+
+
+
+
- endcustomerInfo
-number
+Object
-
-
- <optional>
-
-
+
+
+ Properties
-
-
-
+
+
+
+
+ Name
+
- millisecond end time
+ Type
+
+
+
+
+
+ Description
+
+
+
- limittosAccepted
-number
+Object
-
-
- <optional>
-
-
+
+
+ TOS Accepted by customer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ privateNote
+
-
+Object
+
+
+
+
+
- number of records (Max 100), default 10
Private note
@@ -20954,7 +25730,7 @@ Returns:
- payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@ Source:
See:
- -
-
-
@@ -21064,18 +25833,127 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+ query parameters
+ Properties
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+string
+
+
+
+
+
+
+
+
+
+ unique invoice identifier
+
+
+
+
+
+ ccy
+
+
+string
+
+
+
+
+
+
+
+
+
+ currency to be refunded
+
+
+
+
+
+ amount
+
+string
+
+
+
+
+
+
+
+
+ amount to be refunded
+
+
+
+
+
+ address
+
+object
+
+
+
+
-
-
- query parameters
+ address of refund
Properties
@@ -21089,8 +25967,6 @@ Properties
Type
- Attributes
-
@@ -21103,79 +25979,73 @@ Properties
- pageaddress
-number
+object
-
-
- <optional>
-
-
-
-
-
-
-
- Current page, default 1 100
address of the wallet
- pageSizepayment_id
-number
+object
-
-
- <optional>
-
-
-
-
-
-
+ tag memo
- Number of records per page, default 10, max 100
+
+
+
+
+
- sortcb
-string
+function
@@ -21195,153 +26065,164 @@ Properties
- Sort order, default asc, accepted values are asc and desc
legacy callback
+
+
-
-
- sortField
-
-
-string
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Sort field, default t, allowed values: t, amount, status
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- status
+
+
-
-string
+
-
-
+ payRemoveCurrencyConversion(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- invoice status, allowed array item values are:
-CREATED, PENDING, COMPLETED, EXPIRED
+
+ - Source:
+
-
- fiat
-
-
-Array.<string>
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- fiat filter, should be array of strings
+
-
-
- crypto
-
-
-Array.<string>
+
+
-
-
+
+ - See:
+ -
+
+
+
-
-
-
- <optional>
-
+
+
-
-
-
-
-
- crypto filter, should be array of strings
+
+ Remove bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- idparams.baseCcy
-string
+number
@@ -21350,8 +26231,6 @@ Properties
- <optional>
-
@@ -21361,20 +26240,20 @@ Properties
- unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- orderIdparams.convertCcy
-string
+number
@@ -21383,8 +26262,6 @@ Properties
- <optional>
-
@@ -21394,14 +26271,7 @@ Properties
- erchant order id
-
-
-
-
-
-
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
@@ -21498,7 +26368,7 @@ performanc
- Source:
positionsSource:
positio
- Source:
posit
- Source:
posi
- Source:
pub
- Source:
pub
- Source:
pulseHist
- Source:
statsSource:
statusSource:
statusM
- Source:
subm
- Source:
sub
- Source:
submitOrde
- Source:
submi
- Source:
symbolDe
- Source:
symbolsSource:
tickerSource:
tickersSource:
tickers
- Source:
tradesSource:
transferSource:
updateOrde
- Source:
updat
- Source:
updateS
- Source:
userInfoSource:
walletsSource:
wallets
- Source:
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html
index 5e44d3c..76bd584 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -136,7 +136,7 @@ ClientOrderIdPayload
- Source:
MultiOrderOp
- Source:
MultiOrderOpPayload
- Source:
Type:
diff --git a/docs/index.html b/docs/index.html
index 0b7a6ab..ab62384 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -125,7 +125,7 @@ nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
index 4148a45..35ea7e4 100644
--- a/docs/rest1.js.html
+++ b/docs/rest1.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -662,7 +662,7 @@ rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
index 677a8fc..2ae3429 100644
--- a/docs/rest2.js.html
+++ b/docs/rest2.js.html
@@ -29,7 +29,7 @@
- Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
+ Home
Classes
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
Global
@@ -266,6 +266,9 @@ rest2.js
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if (cb !== null && typeof cb !== 'function') {
+ throw new Error('callback must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1970,6 +1973,7 @@ rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1983,6 +1987,91 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceUpdate (params, cb = null) {
+ return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -2018,21 +2107,60 @@ rest2.js
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -2044,6 +2172,98 @@ rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
@@ -2094,7 +2314,7 @@ rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js
index 0dabe4d..634b42c 100644
--- a/lib/rest2.js
+++ b/lib/rest2.js
@@ -220,6 +220,9 @@ class RESTv2 {
* @private
*/
async _makePublicRequest (path, cb, transformer) {
+ if ((cb !== null && cb !== undefined) && typeof cb !== 'function') {
+ throw new Error('_makePublicRequest cb param must be a function')
+ }
const url = `${this._url}/v2${path}`
debug('GET %s', url)
@@ -1924,6 +1927,7 @@ class RESTv2 {
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name
* @param {string} params.customerInfo.fullName - customer's full name
* @param {string} params.customerInfo.email - customer's email address
+ * @param {string} [params.customerInfo.ip] - customer's ip
* @param {object} [params.meta] - metadata
* @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
* staging, development
@@ -1937,6 +1941,76 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb)
}
+ /**
+ * @param {object} params - invoice parameters
+ * @param {string} params.amount - invoice amount in currency
+ * @param {string} params.currency - invoice currency
+ * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments
+ * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration
+ * is 5 mins and maximal duration is 3 days.
+ * Default value is 15 minutes
+ * @param {string} params.orderId - reference order identifier in merchant's platform
+ * @param {string} [params.webhook] - the endpoint that will be called once the payment is
+ * completed or expired
+ * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect
+ * @param {object} [params.meta] - metadata
+ * @param {string} [params.meta.env] - merchant environment, allowed values: production, test,
+ * staging, development
+ * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of
+ * tag is 5 characters
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCreatePos (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb)
+ }
+
+ /**
+ * @param {Object} params - An object containing the following properties:
+ * @param {Object} params.id - The id property.
+ * @param {Object} params.fields
+ * @param {Object} params.fields.customerInfo
+ * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer
+ * @param {Object} params.privateNote - Private note
+ *
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceUpdate (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payPublicInvoiceCurrencyDetailed (params = {}, cb = null) {
+ return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb)
+ }
+
+ /**
+ * @param {object} params - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceCurrencyDetailed (params, cb = null) {
+ return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb)
+ }
+
+ /**
+ * @param {object} parameters - list of feedbacks
+ * @param {boolean} params.detailed - detailed
+ * @param {string?} params.id - invoice id
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payCurrencyList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb)
+ }
+
/**
* @param {object} [params] - query parameters
* @param {string} [params.id] - unique invoice identifier
@@ -1972,21 +2046,60 @@ class RESTv2 {
}
/**
- * @param {object} params - query parameters
- * @param {string} params.id - unique invoice identifier
- * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
- * on invoice
- * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
- * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
- * or ledgerId
- * @param {Function} [cb] - legacy callback
+ * @param {object} [params] - query parameters
+ * @param {string} [params.id] - invoice id of which events will be returned
+ *
* @returns {Promise} p
- * @see https://docs.bitfinex.com/reference#complete-invoice
+ */
+ payInvoiceEvents (params = {}, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field
+ * on invoice
+ * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment
+ * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment
+ * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId
+ * or ledgerId
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/complete-invoice
*/
payInvoiceComplete (params, cb = null) {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb)
}
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.ccy - currency to be refunded
+ * @param {string} params.amount - amount to be refunded
+ * @param {object} params.address - address of refund
+ * @param {object} params.address.address - address of the wallet
+ * @param {object} params.address.payment_id - tag memo
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payRefundInvoice (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb)
+ }
+
+ /**
+ * @param {object} params - query parameters
+ * @param {string} params.id - unique invoice identifier
+ * @param {string} params.refundId - id of the refund
+
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ */
+ payInvoiceMarkRefunded (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.id - unique invoice identifier
@@ -1998,6 +2111,98 @@ class RESTv2 {
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb)
}
+ /**
+ * List bitfinex pay currency conversions
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/conversion-list
+ */
+ payCurrencyConversionList (cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb)
+ }
+
+ /**
+ * Add bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/add-conversion
+ */
+ payAddCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb)
+ }
+
+ /**
+ * Remove bitfinex pay currency conversions
+ * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/remove-conversion
+ */
+ payRemoveCurrencyConversion (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb)
+ }
+
+ /**
+ * Returns the daily limits for merchant
+ * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-limits
+ */
+ payMerchantDailyLimit (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {string} params.value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write
+ */
+ payMerchantSettingsWrite (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb)
+ }
+
+ /**
+ * Sets merchant settings
+ * @param {string} params.settings - Setting keys and values
+ * @param {string} params.settings[].key - Setting key. Check doc link for possible values
+ * @param {string} params.settings[].value - Setting value, if null it means unset
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch
+ */
+ payMerchantSettingsWriteBatch (params, cb = null) {
+ return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb)
+ }
+
+ /**
+ * Reads merchant settings
+ * @param {string} params.key - Setting key. Check doc link for possible values
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-read
+ */
+ payMerchantSettingsRead (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb)
+ }
+
+ /**
+ * Reads multiple merchant settings
+ * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned
+ * @param {Function} [cb] - legacy callback
+ * @returns {Promise} p
+ * @see https://docs.bitfinex.com/reference/merchant-settings-list
+ */
+ payMerchantSettingsList (params, cb = null) {
+ return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb)
+ }
+
/**
* @param {object} params - query parameters
* @param {string} params.ccy - pay currency to search deposits for
diff --git a/package.json b/package.json
index 6e2625e..f7b74f9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bfx-api-node-rest",
- "version": "5.1.1",
+ "version": "5.2.0",
"description": "Official Bitfinex REST v1 & v2 API interfaces",
"engines": {
"node": ">=8.3.0"
@@ -37,14 +37,15 @@
"Paolo Ardoino (https://www.bitfinex.com)",
"Jacob Plaster (https://www.bitfinex.com)",
"Abhishek Shrestha (https://www.bitfinex.com)",
- "Vigan Abdurrahmani (https://www.bitfinex.com)"
+ "Vigan Abdurrahmani (https://www.bitfinex.com)",
+ "Sergio López (https://www.bitfinex.com)"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
},
"devDependencies": {
- "bfx-api-mock-srv": "^1.2.0",
+ "bfx-api-mock-srv": "^1.5.0",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"docdash": "^1.2.0",
diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
index b69f92a..1eed874 100644
--- a/test/lib/rest-2-integration.js
+++ b/test/lib/rest-2-integration.js
@@ -156,10 +156,26 @@ describe('RESTv2 integration (mock server) tests', () => {
['payInvoiceCreate', 'invoice_submit', [{}]],
['payInvoiceList', 'invoice_list', [{}]],
['payInvoiceComplete', 'invoice_complete', [{}]],
+ ['payCurrencyConversionList', 'pay_settings_convert_list', []],
+ ['payAddCurrencyConversion', 'pay_settings_convert_create', [{}]],
+ ['payRemoveCurrencyConversion', 'pay_settings_convert_remove', [{}]],
+ ['payMerchantDailyLimit', 'pay_settings_daily_limit', [{}]],
+ ['payMerchantSettingsWrite', 'pay_settings_set', [{}]],
+ ['payMerchantSettingsWriteBatch', 'pay_settings_set_batch', [{}]],
+ ['payMerchantSettingsRead', 'pay_settings_get', [{}]],
+ ['payMerchantSettingsList', 'pay_settings_list', [{}]],
['getCoreSettings', 'core_settings', [[]]],
- ['invalidateAuthToken', 'delete_token', [[]]],
+ ['invalidateAuthToken', 'delete_token', [[{}]]],
['payDepositsUnlinked', 'deposits_unlinked', [{}]],
- ['movementInfo', 'movement_info.id', [{ id: 'id' }]]
+ ['movementInfo', 'movement_info.id', [{ id: 'id' }]],
+ ['payRefundInvoice','pay_invoice_refund', [{}]],
+ ['payInvoiceMarkRefunded','pay_invoice_mark_refunded', [{}]],
+ ['payInvoiceEvents','pay_invoice_events', [{}]],
+ ['payPublicInvoiceCurrencyDetailed','pay_public_invoice_currency_detailed', [{}]],
+ ['payInvoiceCurrencyDetailed','pay_currency_detailed', [{}]],
+ ['payCurrencyList','pay_currency_list', [{}]],
+ ['payInvoiceUpdate','pay_invoice_update', [{}]],
+ ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
]
methods.forEach((m) => {
orderHist
Source:
or
Source:
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
orderMult
Source:
orderTrade
Source:
Returns:
- payDeposits(paramsopt, cbopt) → {Promise}
+ payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@ payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
Returns:
-payDeposits(paramsopt, cbopt) → {Promise}
+payAddCurrencyConversion(cbopt) → {Promise}
@@ -18319,7 +18319,7 @@payDeposit
Source:
payDeposit
See:
@@ -18365,6 +18365,10 @@ payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
payDeposit
+
+ Add bitfinex pay currency conversions
+
+
@@ -18402,13 +18406,13 @@ Parameters:
- paramsparams.baseCcy
-object
+number
@@ -18417,8 +18421,6 @@ Parameters:
- <optional>
-
@@ -18428,35 +18430,14 @@ Parameters:
- query parameters
- Properties
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+ Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- idparams.convertCcy
@@ -18471,8 +18452,6 @@ Properties
- <optional>
-
@@ -18482,21 +18461,20 @@ Properties
- Deposit/Ledger entry Id to search for, use either id or from and to fields,
-id has priority over from, to fields
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- fromcb
-number
+function
@@ -18516,115 +18494,155 @@ Properties
- Millisecond start time
legacy callback
+
+
-
-
- to
-
-
-number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
- Millisecond end time
+
+
+
+
+
+
+
+Returns:
+
+
+
+ p
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
-
-
- ccy
+
+
-
-string
+
-
-
+ payCurrencyConversionList(cbopt) → {Promise}
-
-
-
- <optional>
-
+
-
-
-
-
-
- Pay currency to search deposits for
+
+ - Source:
+
-
- unlinked
-
-
-boolean
+
+
-
-
+
-
-
-
- <optional>
-
+
-
+
-
-
-
+
-
+
- Include only unlinked payments
+
-
-
-
-
+
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ List bitfinex pay currency conversions
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
Add bitfinex pay currency conversions
+paramsparams.baseCcyParameters:
- @@ -18428,35 +18430,14 @@
Parameters:
-query parameters
-Properties
- - -| Name | - - -Type | - - -Attributes | - - - - -Description | -Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol! |
+
-
|
|---|---|---|---|---|---|
id |
+ params.convertCcy |
@@ -18471,8 +18452,6 @@ Properties |
- <optional> - @@ -18482,21 +18461,20 @@ Properties- | Deposit/Ledger entry Id to search for, use either id or from and to fields, -id has priority over from, to fields |
+ Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol! |
from |
+ cb |
-number
+function
@@ -18516,115 +18494,155 @@ Properties- | Millisecond start time |
+ legacy callback |
to- - - -
Millisecond end time
p
+ccypayCurrencyConversionList(cbopt) → {Promise}
- -- + - - -
Pay currency to search deposits for
unlinked- + - + - -
Include only unlinked payments
List bitfinex pay currency conversions
+| Name | + + +Type | + + +Attributes | + + + +Default | + + +Description | +|
|---|---|---|---|---|---|
+
+ null
+
+ |
+
legacy callback |
||||
params |
+ parameters |
@@ -18826,41 +18843,20 @@ Parameters:- | query parameters -Properties- + | list of feedbacks |
+
| Name | - + -Type | +|||
|---|---|---|---|---|
params.detailed |
+
-
- Attributes | - - - - -Description | -||
ccy |
-
-
- - - -string + |
+
+
+boolean
@@ -18878,20 +18874,20 @@ Properties- | pay currency to search deposits for |
+ detailed |
start |
+ params.id |
-number
+string
@@ -18900,43 +18896,9 @@ Properties |
- <optional> - - - - - - |
-
-
-
-
- millisecond start time, if omitted it will be end - 1 day if end is present -otherwise it will be yesterday. Min value is 1614758400000 |
-
end |
-
-
- - - -number - - - - | - -
-
- <optional> - + <nullable> @@ -18945,16 +18907,7 @@ Properties- | Millisecond end time, if omitted it will be start + 1 day if start is present -otherwise it will be current time. Max difference between start and end -is 2 days! |
-
invoice id
Returns:
-payInvoiceComplete(params, cbopt) → {Promise}
+payDeposits(paramsopt, cbopt) → {Promise}
@@ -19051,7 +19004,7 @@pay
Source:
Parameters:
+ <optional>
+
@@ -19192,7 +19147,7 @@ Properties
-string
+number
@@ -19201,6 +19156,8 @@ Properties
+ <optional>
+
@@ -19210,20 +19167,21 @@ Properties
- unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields,
+id has priority over from, to fields
- payCcyfrom
-string
+number
@@ -19232,6 +19190,8 @@ Properties
+ <optional>
+
@@ -19241,15 +19201,14 @@ Properties
- paid invoice currency, should be one of values under payCurrencies field
-on invoice
Millisecond start time
- depositIdto
@@ -19275,20 +19234,20 @@ Properties
- movement/deposit Id linked to invoice as payment
Millisecond end time
- ledgerIdccy
-number
+string
@@ -19308,8 +19267,40 @@ Properties
- ledger entry Id linked to invoice as payment, use either depositId
-or ledgerId
Pay currency to search deposits for
+
+
+
+
+
+ unlinked
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ Include only unlinked payments
@@ -19401,7 +19392,7 @@ Returns:
- payInvoiceCreate(params, cbopt) → {Promise}
+ payDepositsUnlinked(params, cbopt) → {Promise}
@@ -19413,7 +19404,7 @@ payIn
Source:
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
++ @@ -19192,7 +19147,7 @@
Properties
Properties
+ @@ -19210,20 +19167,21 @@
Properties
-unique invoice identifier
Deposit/Ledger entry Id to search for, use either id or from and to fields, +id has priority over from, to fields
payCcyfromProperties
+ @@ -19241,15 +19201,14 @@
Properties
-paid invoice currency, should be one of values under payCurrencies field -on invoice
Millisecond start time
depositIdtoProperties
-movement/deposit Id linked to invoice as payment
Millisecond end time
ledgerIdccyProperties
-ledger entry Id linked to invoice as payment, use either depositId -or ledgerId
Pay currency to search deposits for
unlinked+ + + + + +
Include only unlinked payments
payIn
See:
@@ -19520,7 +19511,7 @@ Parameters:
- invoice parameters
+ query parameters
Properties
@@ -19548,7 +19539,7 @@ Properties
- amountccy
@@ -19572,20 +19563,20 @@ Properties
- invoice amount in currency
pay currency to search deposits for
- currencystart
-string
+number
@@ -19594,6 +19585,8 @@ Properties
+ <optional>
+
@@ -19603,20 +19596,21 @@ Properties
- invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present
+otherwise it will be yesterday. Min value is 1614758400000
- payCurrenciesend
-Array.<string>
+number
@@ -19625,6 +19619,8 @@ Properties
+ <optional>
+
@@ -19634,20 +19630,29 @@ Properties
- currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present
+otherwise it will be current time. Max difference between start and end
+is 2 days!
+
+
+
invoice parameters
+query parameters
Properties
@@ -19548,7 +19539,7 @@Properties
amountccyProperties
-invoice amount in currency
pay currency to search deposits for
currencystartProperties
+ @@ -19603,20 +19596,21 @@
Properties
-invoice currency
millisecond start time, if omitted it will be end - 1 day if end is present +otherwise it will be yesterday. Min value is 1614758400000
payCurrenciesendProperties
+ @@ -19634,20 +19630,29 @@
Properties
-currencies in which invoice accepts the payments
Millisecond end time, if omitted it will be start + 1 day if start is present +otherwise it will be current time. Max difference between start and end +is 2 days!
durationcbProperties
-optional, invoice expire time in seconds, minimal duration -is 5 mins and maximal duration is 3 days. -Default value is 15 minutes
legacy callback
orderIdreference order identifier in merchant's platform
webhook- - +
Returns:
- -
+
-
- p
+the endpoint that will be called once the payment is -completed or expired
-
+
- + Type + +
-
+
+Promise
-
- - +redirectUrl- - -string + + + - - + + -- - <optional> - - -
- - + + +payInvoiceComplete(params, cbopt) → {Promise}
+ + - -merchant redirect URL, this one is used in UI to redirect -customer to merchant's site once the payment is completed -or expired
-
+
+
+
- Source: +
- -
- See: +
- + + + + + + + + + + -
- + Type + +
- + +Promise - - + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- See: +
- + + + + + + + + + + + + + + + + + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- See: +
- + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- See: +
- + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- See: +
- + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- See: +
- + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- See: +
- + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- See: +
- + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- See: +
- + + + + + +
- + Type + +
- + +Promise + + + +
- Source: +
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- See: +
- + + + + + +
- Source:
- @@ -20377,13 +25136,6 @@
- See: -
- - - @@ -20454,7 +25206,7 @@
- Source:
- @@ -20630,13 +25382,6 @@
- See: -
- - - @@ -20689,7 +25434,7 @@
- @@ -20996,13 +25772,6 @@
- - - @@ -21064,18 +25833,127 @@
- + Type + +
- + +Promise + + + +
- Source: +
- + -
- See: +
- + + + - -
- Source:
- @@ -21716,7 +26586,7 @@
- @@ -21934,7 +26804,7 @@
- Source:
- @@ -22300,7 +27170,7 @@
- Source:
- @@ -22633,7 +27503,7 @@
- Source:
- @@ -22966,7 +27836,7 @@
- Source:
- @@ -23242,7 +28112,7 @@
- Source:
- @@ -23495,7 +28365,7 @@
- Source:
- @@ -23748,7 +28618,7 @@
- @@ -24024,7 +28894,7 @@
- @@ -24242,7 +29112,7 @@
- Source:
- @@ -24542,7 +29412,7 @@
- Source:
- @@ -24884,7 +29754,7 @@
- Source:
- @@ -25134,7 +30004,7 @@
- Source:
- @@ -25384,7 +30254,7 @@
- Source:
- @@ -25634,7 +30504,7 @@
- Source:
- @@ -25905,7 +30775,7 @@
- @@ -26127,7 +30997,7 @@
- @@ -26380,7 +31250,7 @@
- @@ -26647,7 +31517,7 @@
- Source:
- @@ -27013,7 +31883,7 @@
- @@ -27408,7 +32278,7 @@
- @@ -27750,7 +32620,7 @@
- Source:
- @@ -27963,7 +32833,7 @@
- Source:
- @@ -28213,7 +33083,7 @@
- Source:
- @@ -28459,7 +33329,7 @@
- @@ -28782,7 +33652,7 @@
- @@ -29000,7 +33870,7 @@
- Source:
- @@ -29300,7 +34170,7 @@
- @@ -29618,7 +34488,7 @@
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
- Source:
- @@ -280,7 +280,7 @@
- Source:
- @@ -427,7 +427,7 @@
- Source:
- @@ -566,7 +566,7 @@
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
- RESTv1
- account_infos
- active_credits
- active_offers
- active_orders
- active_positions
- balance_history
- cancel_all_orders
- cancel_multiple_orders
- cancel_offer
- cancel_order
- claim_position
- close_swap
- fundingbook
- get_symbols
- lends
- margin_infos
- movements
- multiple_new_orders
- new_deposit
- new_offer
- new_order
- offer_status
- order_status
- orderbook
- orders_history
- past_trades
- replace_order
- stats
- symbols_details
- taken_swaps
- ticker
- today
- total_taken_swaps
- trades
- transfer
- wallet_balances
- withdraw
- RESTv2
- accountFees
- accountSummary
- accountTrades
- activeOrders
- activeOrdersWithIds
- addPulse
- addPulseComment
- alertDelete
- alertList
- alertSet
- calcAvailableBalance
- cancelAllFundingOffers
- cancelFundingOffer
- cancelOrder
- cancelOrderMulti
- cancelOrders
- cancelOrderWithCid
- candles
- changeLogs
- claimPosition
- closeFunding
- closePosition
- conf
- currencies
- deletePulse
- deleteSettings
- derivsPositionCollateralSet
- exchangeRate
- fetchPulseComments
- fundingCreditHistory
- fundingCredits
- fundingInfo
- fundingLoanHistory
- fundingLoans
- fundingOfferHistory
- fundingOffers
- fundingTrades
- futures
- generateInvoice
- generateToken
- getCoreSettings
- getDepositAddress
- getSettings
- getURL
- inactiveSymbols
- invalidateAuthToken
- keepFunding
- keyPermissions
- ledgers
- liquidations
- lnxInvoicePayments
- logins
- marginInfo
- marketAveragePrice
- movementInfo
- movements
- orderBook
- orderHistory
- orderHistoryWithIds
- orderMultiOp
- orderTrades
- payAddCurrencyConversion
- payCurrencyConversionList
- payCurrencyList
- payDeposits
- payDepositsUnlinked
- payInvoiceComplete
- payInvoiceCreate
- payInvoiceCreatePos
- payInvoiceCurrencyDetailed
- payInvoiceEvents
- payInvoiceExpire
- payInvoiceList
- payInvoiceListPaginated
- payInvoiceMarkRefunded
- payInvoiceUpdate
- payMerchantDailyLimit
- payMerchantSettingsList
- payMerchantSettingsRead
- payMerchantSettingsWrite
- payMerchantSettingsWriteBatch
- payPublicInvoiceCurrencyDetailed
- payPublicInvoiceUpdate
- payRefundInvoice
- payRemoveCurrencyConversion
- performance
- positions
- positionsAudit
- positionsHistory
- positionsSnapshot
- publicPulseHistory
- publicPulseProfile
- pulseHistory
- stats
- status
- statusMessages
- submitAutoFunding
- submitFundingOffer
- submitOrder
- submitOrderMulti
- symbolDetails
- symbols
- ticker
- tickers
- tickersHistory
- trades
- transfer
- updateOrder
- updateOrderMulti
- updateSettings
- userInfo
- usesAgent
- wallets
- walletsHistory
- withdraw
- - customerInfo- - -object - - - -- - - - - - -information related to customer against who the invoice -is issued
-Properties
- + + + +Parameters:
+@@ -19829,13 +19819,13 @@
-Properties
- +nationalityparams-string +object @@ -19853,15 +19843,35 @@ Properties
-customer's nationality, alpha2 code or full country name -(alpha2 preffered)
query parameters
+Properties
+ + ++ +
+ ++ + + +Name + + +Type + + +Attributes + + + + +Description +- residCountryid@@ -19885,15 +19895,14 @@ Properties
-customer's residential country, alpha2 code or -full country name (alpha2 preffered)
unique invoice identifier
- residStatepayCcy@@ -19908,8 +19917,6 @@ Properties
- <optional>
- @@ -19919,20 +19926,21 @@Properties
-optional, customer's residential state/province
paid invoice currency, should be one of values under payCurrencies field +on invoice
- residCitydepositId-string +number @@ -19941,6 +19949,8 @@ Properties
+ <optional>
+ @@ -19950,20 +19960,20 @@Properties
-customer's residential city/town
movement/deposit Id linked to invoice as payment
- residZipCodedepositIds-string +Array.<number> @@ -19972,6 +19982,8 @@ Properties
+ <optional>
+ @@ -19981,20 +19993,20 @@Properties
-customer's residential zip code/postal code
movement/deposit ids list linked to invoice as payment
- + + + +residStreetledgerId-string +number @@ -20003,6 +20015,8 @@ Properties
+ <optional>
+ @@ -20012,20 +20026,28 @@Properties
-customer's residential street address
ledger entry Id linked to invoice as payment, use either depositId +or ledgerId
- + +residBuildingNocb-string +function @@ -20045,114 +20067,131 @@ Properties
-optional, customer's residential building number/name
legacy callback
- - - -fullName- - -string - - - -- - - - - - -customer's full name
- - - - - +email- - -string - - - -- - + - + +Returns:
- -+- -p
+customer's email address
-
+
- - @@ -21498,7 +26368,7 @@meta+ + - -object + - - +payInvoiceCreate(params, cbopt) → {Promise}
- -- - <optional> - - -
- + - - -metadata
-Properties
- +-
-
- + +
+ + + + + + + + + + + + + + + + +Parameters:
+ + ++
+ + + + + + +Name @@ -20175,7 +20214,59 @@Properties
- envparams+ + +object + + + + + + ++ + + + + + + + + + +invoice parameters
+Properties
+ + ++ +
++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +amount@@ -20190,7 +20281,36 @@ Properties
- <optional> + + + + +
+ + + + +invoice amount in currency
+ + currency+ + +string + + + + + + +@@ -20201,15 +20321,14 @@ Properties
-merchant environment, allowed values: production, test, -staging, development
invoice currency
- + + + +tagspayCurrencies@@ -20219,6 +20338,37 @@ + + +Properties
++ + + + + + + + + + +currencies in which invoice accepts the payments
+ + - -duration+ + +number + + + @@ -20235,15 +20385,4624 @@Properties
-invoice tags, max number of tags is 5 and max length of -tag is 5 characters
optional, invoice expire time in seconds, minimal duration +is 5 mins and maximal duration is 3 days. +Default value is 15 minutes
+ + + + + +orderId+ + +string + + + + + + ++ + + + + + + + + + +reference order identifier in merchant's platform
+ + + + + +webhook+ + +string + + + + + ++ + <optional> + + + + +
+ + + + + +the endpoint that will be called once the payment is +completed or expired
+ + + + + +redirectUrl+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +merchant redirect URL, this one is used in UI to redirect +customer to merchant's site once the payment is completed +or expired
+ + + + + +customerInfo+ + +object + + + + + + ++ + + + + + + + + + +information related to customer against who the invoice +is issued
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +nationality+ + +string + + + + + + ++ + + + + + + + + + +customer's nationality, alpha2 code or full country name +(alpha2 preffered)
+ + + + + +residCountry+ + +string + + + + + + ++ + + + + + + + + + +customer's residential country, alpha2 code or +full country name (alpha2 preffered)
+ + + + + +residState+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +optional, customer's residential state/province
+ + + + + +residCity+ + +string + + + + + + ++ + + + + + + + + + +customer's residential city/town
+ + + + + +residZipCode+ + +string + + + + + + ++ + + + + + + + + + +customer's residential zip code/postal code
+ + + + + +residStreet+ + +string + + + + + + ++ + + + + + + + + + +customer's residential street address
+ + + + + +residBuildingNo+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +optional, customer's residential building number/name
+ + + + + +fullName+ + +string + + + + + + ++ + + + + + + + + + +customer's full name
+ + + + + +email+ + +string + + + + + + ++ + + + + + + + + + +customer's email address
+ + + + + +ip+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +customer's ip
+ + + + + +meta+ + +object + + + + + + ++ + <optional> + + + + +
+ + + + + +metadata
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +env+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +merchant environment, allowed values: production, test, +staging, development
+ + + + + +tags+ + +Array.<string> + + + + + + ++ + <optional> + + + + +
+ + + + + +invoice tags, max number of tags is 5 and max length of +tag is 5 characters
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payInvoiceCreatePos(params, cbopt) → {Promise}
+ + + + + + +-
+
+
+
Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params+ + +object + + + + + + ++ + + + + + + + + + +invoice parameters
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +amount+ + +string + + + + + + ++ + + + + + + + + + +invoice amount in currency
+ + + + + +currency+ + +string + + + + + + ++ + + + + + + + + + +invoice currency
+ + + + + +payCurrencies+ + +Array.<string> + + + + + + ++ + + + + + + + + + +currencies in which invoice accepts the payments
+ + + + + +duration+ + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +optional, invoice expire time in seconds, minimal duration +is 5 mins and maximal duration is 3 days. +Default value is 15 minutes
+ + + + + +orderId+ + +string + + + + + + ++ + + + + + + + + + +reference order identifier in merchant's platform
+ + + + + +webhook+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +the endpoint that will be called once the payment is +completed or expired
+ + + + + +redirectUrl+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +merchant redirect URL, this one is used in UI to redirect
+ + + + + +meta+ + +object + + + + + + ++ + <optional> + + + + +
+ + + + + +metadata
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +env+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +merchant environment, allowed values: production, test, +staging, development
+ + + + + +tags+ + +Array.<string> + + + + + + ++ + <optional> + + + + +
+ + + + + +invoice tags, max number of tags is 5 and max length of +tag is 5 characters
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
+ + + + + + +-
+
+
+
Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params+ + +object + + + + + + ++ + + + + + + + + + +list of feedbacks
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +detailed+ + +boolean + + + + + + + + + +detailed
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payInvoiceEvents(paramsopt) → {Promise}
+ + + + + + +-
+
+
+
Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params+ + +object + + + + + + ++ + <optional> + + + + +
+ + + + + +query parameters
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +id+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +invoice id of which events will be returned
Returns:
+ + +++ + + +p
+-
+
payInvoiceExpire(params, cbopt) → {Promise}
+ + + + + + +-
+
+
+
Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params+ + +object + + + + + + ++ + + + + + + + + + +query parameters
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +id+ + +string + + + + + + + + + +unique invoice identifier
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payInvoiceList(paramsopt, cbopt) → {Promise}
+ + + + + + +-
+
+
+
Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params+ + +object + + + + + + ++ + <optional> + + + + +
+ + + + + +query parameters
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +id+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +unique invoice identifier
+ + + + + +start+ + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +millisecond start time
+ + + + + +end+ + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +millisecond end time
+ + + + + +limit+ + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +number of records (Max 100), default 10
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+ + + + + + +-
+
+
+
Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params+ + +object + + + + + + ++ + <optional> + + + + +
+ + + + + +query parameters
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +page+ + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +Current page, default 1 100
+ + + + + +pageSize+ + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +Number of records per page, default 10, max 100
+ + + + + +sort+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +Sort order, default asc, accepted values are asc and desc
+ + + + + +sortField+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +Sort field, default t, allowed values: t, amount, status
+ + + + + +status+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +invoice status, allowed array item values are: +CREATED, PENDING, COMPLETED, EXPIRED
+ + + + + +fiat+ + +Array.<string> + + + + + + ++ + <optional> + + + + +
+ + + + + +fiat filter, should be array of strings
+ + + + + +crypto+ + +Array.<string> + + + + + + ++ + <optional> + + + + +
+ + + + + +crypto filter, should be array of strings
+ + + + + +id+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +unique invoice identifier
+ + + + + +orderId+ + +string + + + + + + ++ + <optional> + + + + +
+ + + + + +erchant order id
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payInvoiceMarkRefunded(params, cbopt) → {Promise}
+ + + + + + +-
+
+
+
Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params+ + +object + + + + + + ++ + + + + + + + + + +query parameters
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +id+ + +string + + + + + + + + + +unique invoice identifier
+ + + + + +refundId+ + +string + + + + + + + + + +id of the refund
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payInvoiceUpdate(params, cbopt) → {Promise}
+ + + + + + +-
+
+
+
Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params+ + +Object + + + + + + ++ + + + + + + + + + +An object containing the following properties:
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +id+ + +Object + + + + + + + + + +The id property.
+ + + + + +fields+ + +Object + + + + + + + + + ++ +Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +customerInfo+ + +Object + + + + + + + + + ++ +Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +tosAccepted+ + +Object + + + + + + + + + +TOS Accepted by customer
+ + + + + +privateNote+ + +Object + + + + + + + + + +Private note
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payMerchantDailyLimit(cbopt) → {Promise}
+ + + + + + +-
+
+
+
++ + + + + + + + + + + +Returns the daily limits for merchant
+Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params.customerEmails+ + +Array.<string> + + + + + + ++ + <optional> + + + + +
+ + + + + +Optional, customer emails for e-commerce usage
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payMerchantSettingsList(cbopt) → {Promise}
+ + + + + + +-
+
+
+
++ + + + + + + + + + + +Reads multiple merchant settings
+Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params.keys+ + +Array.<string> + + + + + + ++ + + + + + + + + + +Setting keys, if empty array all settings will be returned
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payMerchantSettingsRead(cbopt) → {Promise}
+ + + + + + +-
+
+
+
++ + + + + + + + + + + +Reads merchant settings
+Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params.key+ + +string + + + + + + ++ + + + + + + + + + +Setting key. Check doc link for possible values
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payMerchantSettingsWrite(cbopt) → {Promise}
+ + + + + + +-
+
+
+
++ + + + + + + + + + + +Sets merchant settings
+Parameters:
+ + ++ +
+ + + + + + + + + + + + + + + + ++ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + + + + +params.key+ + +string + + + + + + ++ + + + + + + + + + +Setting key. Check doc link for possible values
+ + + + + +params.value+ + +string + + + + + + ++ + + + + + + + + + +Setting value, if null it means unset
+ + + + + +cb+ + +function + + + + + + ++ + <optional> + + + + +
+ + + + + +legacy callback
Returns:
+ + +++ + + +p
+-
+
payMerchantSettingsWriteBatch(cbopt) → {Promise}
+ + + + + + +-
+
+
+
++ + + + + + + + + + + +Sets merchant settings
+Parameters:
+ + ++ +
-+ + + + + + + +Name + + +Type + + +Attributes + + + + +Description ++ + params.settings+ + +string + + + + + + ++ + + + + + + + + + +Setting keys and values
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +key+ + +string + + + + + + + + + +Setting key. Check doc link for possible values
+ + @@ -20335,7 +25094,7 @@value+ + +string + + + + + + + + + +Setting value, if null it means unset
Returns:
-payInvoiceExpire(params, cbopt) → {Promise}
+payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
@@ -20347,7 +25106,7 @@payIn
+payIn - -
Parameters:
-query parameters
+list of feedbacks
Properties
@@ -20480,13 +25232,13 @@Properties
- @@ -20588,7 +25340,7 @@iddetailed-string +boolean @@ -20496,7 +25248,7 @@ Properties
-unique invoice identifier
detailed
Returns:
-payInvoiceList(paramsopt, cbopt) → {Promise}
+payPublicInvoiceUpdate(params, cbopt) → {Promise}
@@ -20600,7 +25352,7 @@payInvo
payInvo - -
Parameters:
-object +Object @@ -20698,8 +25443,6 @@ Parameters:
- <optional>
- @@ -20709,7 +25452,7 @@Parameters:
-query parameters
+An object containing the following properties:
Properties
@@ -20723,8 +25466,6 @@Properties
Type -Attributes - @@ -20743,126 +25484,161 @@Properties
-string +Object -- - <optional> - -
- - - - - -unique invoice identifier
The id property.
- + + + +startfields-number +Object -- - <optional>
- - + ++ - - +Properties
-+ +
+ + ++ + +Name + -millisecond start time
Type + + + + +Description + + + +- + + + +endcustomerInfo-number +Object -- - <optional>
- - + ++ - - +Properties
-+ +
+ + ++ + +Name + -millisecond end time
Type + + + + + +Description + + +- + + + +limittosAccepted-number +Object -- - <optional>
- - + + +TOS Accepted by customer
+ + @@ -20954,7 +25730,7 @@privateNote+ - +Object + + + + + -number of records (Max 100), default 10
Private note
Returns:
-payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
+payRefundInvoice(params, cbopt) → {Promise}
@@ -20966,7 +25742,7 @@Source:
See: -
Parameters:
- <optional> + + + + +
+ + + + +query parameters
+Properties
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +id+ + +string + + + + + + + + + +unique invoice identifier
+ + + + + +ccy+ + +string + + + + + + + + + +currency to be refunded
+ + + + + +amount+ +string + + + + + + + + +amount to be refunded
+ + address+ +object + + + + - - -query parameters
+address of refund
Properties
@@ -21089,8 +25967,6 @@Properties
Type -Attributes - @@ -21103,79 +25979,73 @@Properties
- pageaddress-number +object -- - <optional> - -
- - - - - -Current page, default 1 100
address of the wallet
- -pageSizepayment_id-number +object -- - <optional> - +
- - - - -tag memo
Number of records per page, default 10, max 100
- + +sortcb-string +function @@ -21195,153 +26065,164 @@ Properties
-Sort order, default asc, accepted values are asc and desc
legacy callback
- - + + + + + + + +sortField- - -string - - - -- - <optional> - - -
- - - -Sort field, default t, allowed values: t, amount, status
Returns:
+ + +++ + + +p
+-
+
- - +status+ + - -string + - - +payRemoveCurrencyConversion(cbopt) → {Promise}
- -- - <optional> - - -
- + - - -invoice status, allowed array item values are: -CREATED, PENDING, COMPLETED, EXPIRED
-
+
- - + -fiat- - -Array.<string> + + - - + - -- - <optional> - + - + -
- + - + - -fiat filter, should be array of strings
- - +crypto- - -Array.<string> + + - - + +- - <optional> - - -
- + + - - -crypto filter, should be array of strings
++ + + + + + + + + + + +Remove bitfinex pay currency conversions
+Parameters:
+ + ++ +
- -+ + + + +Name + + +Type + + +Attributes + + + + +Description +- idparams.baseCcy-string +number @@ -21350,8 +26231,6 @@ Properties
- <optional>
- @@ -21361,20 +26240,20 @@Properties
-unique invoice identifier
Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
- - - - -orderIdparams.convertCcy-string +number @@ -21383,8 +26262,6 @@ Properties
- <optional>
- @@ -21394,14 +26271,7 @@Properties
-erchant order id
Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!
performanc
positions
Source: positio
posit
posi
pub
pub
pulseHist
statsSource:
statusSource:
statusM
subm
sub
submitOrde
submi
symbolDe
symbolsSource:
tickerSource:
tickersSource:
tickers
tradesSource:
transferSource:
updateOrde
updat
updateS
userInfoSource:
walletsSource:
wallets
withdrawSource:
Returns:
diff --git a/docs/global.html b/docs/global.html index 5e44d3c..76bd584 100644 --- a/docs/global.html +++ b/docs/global.html @@ -29,7 +29,7 @@ -Home
Classes
Global
+Home
Classes
Global
@@ -136,7 +136,7 @@ClientOrderIdPayload
MultiOrderOp
MultiOrderOpPayload
Type:
diff --git a/docs/index.html b/docs/index.html index 0b7a6ab..ab62384 100644 --- a/docs/index.html +++ b/docs/index.html @@ -29,7 +29,7 @@ -Home
Classes
Global
+Home
Classes
Global
@@ -125,7 +125,7 @@nonce too small
diff --git a/docs/rest1.js.html b/docs/rest1.js.html index 4148a45..35ea7e4 100644 --- a/docs/rest1.js.html +++ b/docs/rest1.js.html @@ -29,7 +29,7 @@ -Home
Classes
Global
+Home
Classes
Global
@@ -662,7 +662,7 @@rest1.js
diff --git a/docs/rest2.js.html b/docs/rest2.js.html index 677a8fc..2ae3429 100644 --- a/docs/rest2.js.html +++ b/docs/rest2.js.html @@ -29,7 +29,7 @@ -Home
Classes
Global
+Home
Classes
Global
@@ -266,6 +266,9 @@rest2.js
* @private */ async _makePublicRequest (path, cb, transformer) { + if (cb !== null && typeof cb !== 'function') { + throw new Error('callback must be a function') + } const url = `${this._url}/v2${path}` debug('GET %s', url) @@ -1970,6 +1973,7 @@rest2.js
* @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name * @param {string} params.customerInfo.fullName - customer's full name * @param {string} params.customerInfo.email - customer's email address + * @param {string} [params.customerInfo.ip] - customer's ip * @param {object} [params.meta] - metadata * @param {string} [params.meta.env] - merchant environment, allowed values: production, test, * staging, development @@ -1983,6 +1987,91 @@rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb) } + /** + * @param {object} params - invoice parameters + * @param {string} params.amount - invoice amount in currency + * @param {string} params.currency - invoice currency + * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments + * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration + * is 5 mins and maximal duration is 3 days. + * Default value is 15 minutes + * @param {string} params.orderId - reference order identifier in merchant's platform + * @param {string} [params.webhook] - the endpoint that will be called once the payment is + * completed or expired + * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect + * @param {object} [params.meta] - metadata + * @param {string} [params.meta.env] - merchant environment, allowed values: production, test, + * staging, development + * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of + * tag is 5 characters + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payInvoiceCreatePos (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb) + } + + /** + * @param {Object} params - An object containing the following properties: + * @param {Object} params.id - The id property. + * @param {Object} params.fields + * @param {Object} params.fields.customerInfo + * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer + * @param {Object} params.privateNote - Private note + * + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payPublicInvoiceUpdate (params, cb = null) { + return this._makePublicPostRequest('/auth/ext/pay/invoice/update', params, cb) + } + + /** + * @param {Object} params - An object containing the following properties: + * @param {Object} params.id - The id property. + * @param {Object} params.fields + * @param {Object} params.fields.customerInfo + * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer + * @param {Object} params.privateNote - Private note + * + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payInvoiceUpdate (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb) + } + + /** + * @param {object} params - list of feedbacks + * @param {boolean} params.detailed - detailed + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payPublicInvoiceCurrencyDetailed (params = {}, cb = null) { + return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb) + } + + /** + * @param {object} params - list of feedbacks + * @param {boolean} params.detailed - detailed + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payInvoiceCurrencyDetailed (params, cb = null) { + return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb) + } + + /** + * @param {object} parameters - list of feedbacks + * @param {boolean} params.detailed - detailed + * @param {string?} params.id - invoice id + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payCurrencyList (params, cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb) + } + /** * @param {object} [params] - query parameters * @param {string} [params.id] - unique invoice identifier @@ -2018,21 +2107,60 @@rest2.js
} /** - * @param {object} params - query parameters - * @param {string} params.id - unique invoice identifier - * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field - * on invoice - * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment - * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId - * or ledgerId - * @param {Function} [cb] - legacy callback + * @param {object} [params] - query parameters + * @param {string} [params.id] - invoice id of which events will be returned + * * @returns {Promise} p - * @see https://docs.bitfinex.com/reference#complete-invoice + */ + payInvoiceEvents (params = {}, cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb) + } + + /** + * @param {object} params - query parameters + * @param {string} params.id - unique invoice identifier + * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field + * on invoice + * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment + * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment + * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId + * or ledgerId + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/complete-invoice */ payInvoiceComplete (params, cb = null) { return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb) } + /** + * @param {object} params - query parameters + * @param {string} params.id - unique invoice identifier + * @param {string} params.ccy - currency to be refunded + * @param {string} params.amount - amount to be refunded + * @param {object} params.address - address of refund + * @param {object} params.address.address - address of the wallet + * @param {object} params.address.payment_id - tag memo + + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payRefundInvoice (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb) + } + + /** + * @param {object} params - query parameters + * @param {string} params.id - unique invoice identifier + * @param {string} params.refundId - id of the refund + + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payInvoiceMarkRefunded (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb) + } + /** * @param {object} params - query parameters * @param {string} params.id - unique invoice identifier @@ -2044,6 +2172,98 @@rest2.js
return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb) } + /** + * List bitfinex pay currency conversions + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/conversion-list + */ + payCurrencyConversionList (cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb) + } + + /** + * Add bitfinex pay currency conversions + * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol! + * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol! + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/add-conversion + */ + payAddCurrencyConversion (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb) + } + + /** + * Remove bitfinex pay currency conversions + * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol! + * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol! + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/remove-conversion + */ + payRemoveCurrencyConversion (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb) + } + + /** + * Returns the daily limits for merchant + * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/merchant-limits + */ + payMerchantDailyLimit (params, cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb) + } + + /** + * Sets merchant settings + * @param {string} params.key - Setting key. Check doc link for possible values + * @param {string} params.value - Setting value, if null it means unset + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/merchant-settings-write + */ + payMerchantSettingsWrite (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb) + } + + /** + * Sets merchant settings + * @param {string} params.settings - Setting keys and values + * @param {string} params.settings[].key - Setting key. Check doc link for possible values + * @param {string} params.settings[].value - Setting value, if null it means unset + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch + */ + payMerchantSettingsWriteBatch (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb) + } + + /** + * Reads merchant settings + * @param {string} params.key - Setting key. Check doc link for possible values + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/merchant-settings-read + */ + payMerchantSettingsRead (params, cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb) + } + + /** + * Reads multiple merchant settings + * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/merchant-settings-list + */ + payMerchantSettingsList (params, cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb) + } + /** * @param {object} params - query parameters * @param {string} params.ccy - pay currency to search deposits for @@ -2094,7 +2314,7 @@rest2.js
diff --git a/lib/rest2.js b/lib/rest2.js index 0dabe4d..634b42c 100644 --- a/lib/rest2.js +++ b/lib/rest2.js @@ -220,6 +220,9 @@ class RESTv2 { * @private */ async _makePublicRequest (path, cb, transformer) { + if ((cb !== null && cb !== undefined) && typeof cb !== 'function') { + throw new Error('_makePublicRequest cb param must be a function') + } const url = `${this._url}/v2${path}` debug('GET %s', url) @@ -1924,6 +1927,7 @@ class RESTv2 { * @param {string} [params.customerInfo.residBuildingNo] - optional, customer's residential building number/name * @param {string} params.customerInfo.fullName - customer's full name * @param {string} params.customerInfo.email - customer's email address + * @param {string} [params.customerInfo.ip] - customer's ip * @param {object} [params.meta] - metadata * @param {string} [params.meta.env] - merchant environment, allowed values: production, test, * staging, development @@ -1937,6 +1941,76 @@ class RESTv2 { return this._makeAuthRequest('/auth/w/ext/pay/invoice/create', params, cb) } + /** + * @param {object} params - invoice parameters + * @param {string} params.amount - invoice amount in currency + * @param {string} params.currency - invoice currency + * @param {string[]} params.payCurrencies - currencies in which invoice accepts the payments + * @param {number} [params.duration] - optional, invoice expire time in seconds, minimal duration + * is 5 mins and maximal duration is 3 days. + * Default value is 15 minutes + * @param {string} params.orderId - reference order identifier in merchant's platform + * @param {string} [params.webhook] - the endpoint that will be called once the payment is + * completed or expired + * @param {string} [params.redirectUrl] - merchant redirect URL, this one is used in UI to redirect + * @param {object} [params.meta] - metadata + * @param {string} [params.meta.env] - merchant environment, allowed values: production, test, + * staging, development + * @param {string[]} [params.meta.tags] - invoice tags, max number of tags is 5 and max length of + * tag is 5 characters + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payInvoiceCreatePos (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/invoice/create/pos', params, cb) + } + + /** + * @param {Object} params - An object containing the following properties: + * @param {Object} params.id - The id property. + * @param {Object} params.fields + * @param {Object} params.fields.customerInfo + * @param {Object} params.fields.customerInfo.tosAccepted - TOS Accepted by customer + * @param {Object} params.privateNote - Private note + * + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payInvoiceUpdate (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/invoice/update', params, cb) + } + + /** + * @param {object} params - list of feedbacks + * @param {boolean} params.detailed - detailed + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payPublicInvoiceCurrencyDetailed (params = {}, cb = null) { + return this._makePublicRequest('/ext/pay/invoice/currency/detailed', cb) + } + + /** + * @param {object} params - list of feedbacks + * @param {boolean} params.detailed - detailed + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payInvoiceCurrencyDetailed (params, cb = null) { + return this._makePublicPostRequest('/auth/r/ext/pay/currency/detailed', params, cb) + } + + /** + * @param {object} parameters - list of feedbacks + * @param {boolean} params.detailed - detailed + * @param {string?} params.id - invoice id + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payCurrencyList (params, cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/currency/list', params, cb) + } + /** * @param {object} [params] - query parameters * @param {string} [params.id] - unique invoice identifier @@ -1972,21 +2046,60 @@ class RESTv2 { } /** - * @param {object} params - query parameters - * @param {string} params.id - unique invoice identifier - * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field - * on invoice - * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment - * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId - * or ledgerId - * @param {Function} [cb] - legacy callback + * @param {object} [params] - query parameters + * @param {string} [params.id] - invoice id of which events will be returned + * * @returns {Promise} p - * @see https://docs.bitfinex.com/reference#complete-invoice + */ + payInvoiceEvents (params = {}, cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/invoice/events', params, cb) + } + + /** + * @param {object} params - query parameters + * @param {string} params.id - unique invoice identifier + * @param {string} params.payCcy - paid invoice currency, should be one of values under payCurrencies field + * on invoice + * @param {number} [params.depositId] - movement/deposit Id linked to invoice as payment + * @param {number[]} [params.depositIds] - movement/deposit ids list linked to invoice as payment + * @param {number} [params.ledgerId] - ledger entry Id linked to invoice as payment, use either depositId + * or ledgerId + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/complete-invoice */ payInvoiceComplete (params, cb = null) { return this._makeAuthRequest('/auth/w/ext/pay/invoice/complete', params, cb) } + /** + * @param {object} params - query parameters + * @param {string} params.id - unique invoice identifier + * @param {string} params.ccy - currency to be refunded + * @param {string} params.amount - amount to be refunded + * @param {object} params.address - address of refund + * @param {object} params.address.address - address of the wallet + * @param {object} params.address.payment_id - tag memo + + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payRefundInvoice (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/invoice/refund', params, cb) + } + + /** + * @param {object} params - query parameters + * @param {string} params.id - unique invoice identifier + * @param {string} params.refundId - id of the refund + + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + */ + payInvoiceMarkRefunded (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/invoice/mark/refunded', params, cb) + } + /** * @param {object} params - query parameters * @param {string} params.id - unique invoice identifier @@ -1998,6 +2111,98 @@ class RESTv2 { return this._makeAuthRequest('/auth/w/ext/pay/invoice/expire', params, cb) } + /** + * List bitfinex pay currency conversions + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/conversion-list + */ + payCurrencyConversionList (cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/settings/convert/list', {}, cb) + } + + /** + * Add bitfinex pay currency conversions + * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol! + * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol! + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/add-conversion + */ + payAddCurrencyConversion (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/create', params, cb) + } + + /** + * Remove bitfinex pay currency conversions + * @param {number} params.baseCcy - Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol! + * @param {number} params.convertCcy - Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol! + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/remove-conversion + */ + payRemoveCurrencyConversion (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/settings/convert/remove', params, cb) + } + + /** + * Returns the daily limits for merchant + * @param {string[]} [params.customerEmails] - Optional, customer emails for e-commerce usage + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/merchant-limits + */ + payMerchantDailyLimit (params, cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/settings/daily/limit', params, cb) + } + + /** + * Sets merchant settings + * @param {string} params.key - Setting key. Check doc link for possible values + * @param {string} params.value - Setting value, if null it means unset + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/merchant-settings-write + */ + payMerchantSettingsWrite (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/settings/set', params, cb) + } + + /** + * Sets merchant settings + * @param {string} params.settings - Setting keys and values + * @param {string} params.settings[].key - Setting key. Check doc link for possible values + * @param {string} params.settings[].value - Setting value, if null it means unset + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/merchant-settings-write-batch + */ + payMerchantSettingsWriteBatch (params, cb = null) { + return this._makeAuthRequest('/auth/w/ext/pay/settings/set/batch', params, cb) + } + + /** + * Reads merchant settings + * @param {string} params.key - Setting key. Check doc link for possible values + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/merchant-settings-read + */ + payMerchantSettingsRead (params, cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/settings/get', params, cb) + } + + /** + * Reads multiple merchant settings + * @param {string[]} params.keys - Setting keys, if empty array all settings will be returned + * @param {Function} [cb] - legacy callback + * @returns {Promise} p + * @see https://docs.bitfinex.com/reference/merchant-settings-list + */ + payMerchantSettingsList (params, cb = null) { + return this._makeAuthRequest('/auth/r/ext/pay/settings/list', params, cb) + } + /** * @param {object} params - query parameters * @param {string} params.ccy - pay currency to search deposits for diff --git a/package.json b/package.json index 6e2625e..f7b74f9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "bfx-api-node-rest", - "version": "5.1.1", + "version": "5.2.0", "description": "Official Bitfinex REST v1 & v2 API interfaces", "engines": { "node": ">=8.3.0" @@ -37,14 +37,15 @@ "Paolo Ardoino