Scopes


ScopeDescription
account:readView account details:
  • Get account list.
  • Get single account info.
deposit:readView deposits:
  • Get deposit list.
  • Get deposit history (all and fiat).
deposit-crypto-address:readView crypto deposit addresses. Allows reading of cryptocurrency deposit addresses associated with the user's account.
deposit-crypto-address:createGenerate new crypto deposit addresses. Permits the creation of new cryptocurrency deposit addresses.
exchange:readView currency exchanges:
  • Get exchange history.
  • Get single exchange info.
  • Get exchange pairs.
exchange:createCreate currency exchanges:
  • Get exchange rate for the selected pair.
  • Calculate pay amount.
  • Calculate receive amount.
  • Execute currency exchanges.
withdraw-crypto:readView crypto withdrawals:
  • Get crypto withdrawal details.
  • Get crypto withdrawals history.
withdraw-crypto:createCreate crypto withdrawals:
  • Create operation.
  • Get fee information.
withdraw-bank:readView bank withdrawals. Grants permission to view bank withdrawal transactions and related information.
withdraw-bank:createCreate bank withdrawals. Allows the setup or initiation of bank withdrawal requests.
withdraw-with-exchange:readView withdraw with exchange transactions. Grants permission to view withdrawal-with-exchange transactions and related information.
withdraw-with-exchange:createCreate withdraw with exchange transactions. Allows the creation of withdraw-with-exchange transactions.
merchants-preorders:readView merchant pre-orders. Permits viewing of merchant projects' preorders and related transactions.
merchants-preorders:createCreate merchant preorders. Allows the creation or initiation of preorder transactions for merchant projects.
merchants-orders:readView merchant orders. Enables viewing of orders placed for merchant projects.
merchants-orders:createCreate merchant orders. Allows the creation of new orders for merchant projects.
merchants-orders:cancelCancel merchant orders. Grants permission to cancel existing orders.
account-transaction:readView account transactions. Allows the viewing of the account transactions.
payment-method:readView payment methods. Grants permission to view payment methods associated with the user.
merchants-projects:readView merchant projects. Allows the viewing of merchant projects.
merchants-projects:createCreate merchant projects. Allows the creation of new merchant projects.
merchants-projects:writeWrite to merchant projects. Allows writing to merchant projects.
merchants-orders:payPay merchant orders. Allows payment for merchant orders.
merchants-orders:callbackMerchant orders callback. Allows the callback for merchant orders.
merchants-callbacks:readView merchant callbacks. Allows the viewing of merchant callbacks.
merchants-transactions:readView merchant transactions. Allows the viewing of merchant transactions.
deposit:createCreate deposits. Covers generic deposit creation, the pay/receive amount calculators and voucher deposits. Individual fiat rails (bank, Skrill, Neteller, AdvCash, Apple Pay, Google Pay) require deposit-fiat:create.
deposit-fiat:readView fiat deposits. Allows the viewing of fiat deposit transactions, their CSV/PDF exports and bank deposit descriptions.
deposit-crypto:readView crypto deposits. Allows the viewing of the cryptocurrency deposit transactions.
purchase-gift-card:readView purchased gift cards. Allows the viewing of purchased gift cards.
purchase-gift-card:payPay for gift card purchases. Allows payment for gift card purchases.
withdraw-voucher:readView voucher withdrawals. Allows the viewing of voucher withdrawal transactions.
withdraw-voucher:createCreate voucher withdrawals. Allows the creation of new voucher withdrawal transactions.
withdraw-e-wallet:readView e-wallet withdrawals. Allows the viewing of e-wallet withdrawal transactions.
withdraw-e-wallet:createCreate e-wallet withdrawals. Allows the creation of new e-wallet withdrawal transactions.
deposit-fiat:createCreate fiat deposits. Allows the creation of deposits on the individual fiat rails: bank, Skrill, Neteller, AdvCash, Apple Pay and Google Pay.
deposit-crypto-with-exchange:readView crypto deposits with exchange. Allows the viewing of crypto-deposit-with-exchange transactions and their auto-exchanges, including CSV/PDF exports.
currency-restriction:readView currency restrictions. Allows the viewing of currency and crypto network restrictions that apply to the account.
merchants-orders:acceptAccept merchant orders. Allows accepting an order and estimating its receive amount.
merchants-orders:rejectReject merchant orders. Allows rejecting an order.
merchants-payments:readView merchant payments. Allows the viewing of payments made against merchant orders.
merchants-refunds:readView merchant refunds. Allows the viewing of merchant refunds.
merchants-refunds:createCreate merchant refunds. Allows the creation of merchant refunds and estimating a refund.
crypto-beneficiary:readView crypto withdrawal beneficiaries. Allows the viewing of saved beneficiaries used for crypto withdrawals (Travel Rule).
crypto-beneficiary:createCreate crypto withdrawal beneficiaries. Allows the creation of new beneficiaries.
crypto-beneficiary:writeUpdate crypto withdrawal beneficiaries. Allows editing an existing beneficiary.
crypto-beneficiary:deleteDelete crypto withdrawal beneficiaries. Allows the removal of a beneficiary.
payment-channel:readView payment channels. Allows the viewing of payment channels and their details.
payment-channel:writeManage payment channels. Allows the creation, update and deletion of payment channels, and viewing the currencies they can receive.
payment-channel-address:readView payment channel addresses. Allows the viewing of addresses attached to a payment channel.
payment-channel-address:createCreate payment channel addresses. Allows adding a new address to a payment channel, and viewing the currencies it can be paid in.