Menu
Logo
Logo
Search
  • Release notes
  • Integrations
  • Back Office guide
  • How-to articles
  • B2Core API
  • B2Core Mobile
  • Release notes
    • May 29, 2023
    • April 18, 2023
    • April 4, 2023
    • March 21, 2023
    • February 28, 2023
    • February 14, 2023
    • January 31, 2023
    • January 19, 2023
    • December 20, 2022
    • December 6, 2022
    • November 24, 2022
    • November 8, 2022
    • October 25, 2022
    • October 11, 2022
    • September 27, 2022
    • September 13, 2022
    • August 30, 2022
    • August 16, 2022
    • August 2, 2022
    • July 19, 2022
    • July 5, 2022
    • June 21, 2022
    • June 7, 2022
    • May 24, 2022
    • April 26, 2022
    • April 12, 2022
    • March 29, 2022
    • March 15, 2022
    • March 1, 2022
    • February 15, 2022
    • February 1, 2022
    • January 18, 2022
    • December 21, 2021
    • December 7, 2021
    • November 24, 2021
    • November 9, 2021
    • October 26, 2021
    • October 12, 2021
    • September 28, 2021
    • September 14, 2021
    • August 31, 2021
    • August 3, 2021
    • July 20, 2021
    • July 6, 2021
    • June 22, 2021
    • June 8, 2021
    • May 26, 2021
    • April 27, 2021
    • April 13, 2021
    • March 30, 2021
    • March 16, 2021
    • March 2, 2021
    • February 16, 2021
    • February 2, 2021
  • Integrations
    • Trading platforms
    • Payment systems
    • KYC providers
    • Communication platforms
    • Other systems
  • Back Office guide
    • Get started
      • Authorization and permissions
      • General interface options
        • The top bar options
        • Common options
        • Filtering and sorting
        • Pagination
        • Visibility
        • Data export
    • Clients
      • General
        • The Client tab
        • The Contacts tab
        • The Event log tab
        • The Accounts tab
        • The Transactions tab
        • The Finance tab
        • The History tab
        • The MT Accounts tab
        • The Trades tab
        • The B2Margin Accounts tab
        • The Introducing brokers tab
        • The Services tab
        • The Files tab
        • The Settings tab
        • The Advanced tab
        • The Compliances tab
        • The Devices tab
        • The Documents tab
        • The Mailing Log tab
      • Services
        • Clients
        • List
        • Parameters
        • Categories
        • Groups
        • Saved presets
        • E-Signature
          • Templates
          • Logs
      • Requests
      • Accounts
      • Managers
      • Types
      • Events log
        • List
        • Categories
    • Introducing brokers
    • MT accounts
      • MT4 accounts
      • MT5 accounts
    • Finance
      • Deposits
      • Payouts
      • Deposit wallets
      • Transfers
      • Exchange
      • Transactions
      • Reports
    • Bonuses
      • Bonus presets
      • Bonus distribution
      • Temporary bonuses
    • Currencies
      • Currencies
      • Rates
      • Currency pairs
    • Cashback
      • B2Trader Commission
        • Commission plans
        • Trading data
        • Processing log
        • Distribution log
      • MetaTrader Volume
        • Preferences tab
        • Tiers tab
    • Products
      • Products
      • Groups
      • Rights
      • Platforms
    • PAMM
      • Links
    • Promotion
      • Banners
      • Announcements
      • Dashboard
      • Menu
    • Mailing
      • Marketing
        • Configuration
        • Send email
        • Email templates
      • System
        • Providers
        • Queue
        • Log
    • Ticket feedback
    • Verification
      • Levels
      • Documents
      • Document types
      • Document groups
      • Client tests
    • B2BinPay
      • Wallets
      • Withdrawals
    • System
      • SMS Providers
      • Key storage
        • Key storage values
        • Key storage tags
      • Deposit system
        • Deposit methods
        • Deposit groups
      • Payout system
        • Payout methods
        • Payout groups
      • Wizards
        • Registration
        • Password Recovery
        • Password change
        • Client type change
        • Profile change
        • Phone change
        • Address change
        • Authorization
        • 2FA change
        • Whitelist creation
        • Whitelist delete
        • Whitelist change
        • Withdrawals
        • Wizards
      • Bulk actions
      • Event calendar
      • Operation types
      • Countries
      • External connections
      • Filesystems
      • Localizations
      • Requests
        • Resolutions
        • Resolution types
      • Templates
        • Email
          • Template types
          • Templates
        • SMS
          • General templates
          • Confirmation templates
        • Slack
          • Templates
        • Telegram
          • Templates
      • Logs
      • Settings
      • Event notifications
      • Users
        • Users
        • Groups
        • Client Tags
      • Events
        • Successful registration
        • Transfers
        • Account created
        • Transaction verifying
        • Hedging failed
        • Request receiving
      • Client rights
      • Client folders
      • Backend images
      • Import data
    • Antifraud
      • Antifraud notifications
      • Antifraud settings
      • Antifraud procedures
    • Security
      • Search by IP
      • Blocked clients
      • Black lists
      • White lists
      • Transaction monitoring
      • Address whitelist
    • References
      • Client statuses
      • Client request statuses
      • Transaction statuses
      • Supported currencies
        • Fiat
        • Crypto
      • Supported cryptocurrency payment methods
      • Event types for triggering event notifications for Back Office users
      • Block explorer list
        • Coins
        • Stablecoins
  • How-to articles
    • Manage clients
      • How to create a client profile
      • How to change a client password
      • How to prompt a password reset
      • How to disable 2FA for a client
      • How to enable internal transfers for a client
      • How to view deposit or withdrawal addresses
      • How to upload a file
      • How to assign tags to clients
      • How to resolve client requests
      • How to create categories for the Event log
    • Manage finances
      • How to add, edit or delete deposit or withdrawal methods
        • How to add a manual deposit or withdrawal method
        • How to configure commissions for a deposit or withdrawal method
        • How to restrict the use of a deposit or withdrawal method
        • How to add custom fields for the Constructor deposit or withdrawal method
          • How to upload a list of predefined options for a custom field
          • How to dynamically form a list of predefined options for a custom field
      • How to create a deposit
      • How to create a payout
      • How to create a transfer
      • How to exchange funds
      • How to create a report
    • Manage currencies
      • How to add a currency
      • How to configure currency exchange rates
      • How to add an exchange currency pair
      • How to set priorities for exchange rate providers
    • Manage bonuses
      • How to create a bonus preset
      • How to automatically credit bonuses to clients upon deposits
    • Manage products
      • How to create a wallet
      • How to restrict the use of a product
    • Manage cashback options
      • How to configure commission cashback plans for B2Trader
      • How to modify or remove commission cashback plans
      • How to configure cashback programs for MT4 and MT5
        • How to add cashback reward tiers
        • How to create a deposit method for rewarding cashback
        • How to identify clients who received cashback rewards
    • Manage advertising options
      • How to create a banner
        • How to create a desktop banner
        • How to create a banner for the mobile app
      • How to create an announcement
      • How to configure the default Dashboard
      • How to add Ticker Widget symbols to the Dashboard
      • How to configure a menu in the B2Core UI
    • Manage mailing options
      • How to send an email
      • How to create an email template
      • How to configure SMTP
        • How to sign up with an SMTP service provider
        • How to configure an SMTP service connection via the B2Core Back Office
      • How to configure SendGrid
      • How to determine why clients fail to receive email notifications
    • Manage verification options
      • How to use the KYC constructor
        • How to create document groups
        • How to create documents
        • How to create verification levels
        • How to create permission levels
        • How to set up deposit, withdrawal and transfer limits by verification levels
      • How to use SumSubstance
        • How to configure a connection to the SumSub system
        • How to create verification levels for SumSub
        • How to create document types for SumSub verification via the B2Core Back Office
        • How to create levels and flows via the SumSub interface
        • SumSub webhook configurations
      • How to use ShuftiPro
        • How to configure a connection to ShuftiPro
        • How to create document groups for ShuftiPro verification
        • How to create document types for ShuftiPro verification
        • How to create verification levels for ShuftiPro
      • How to create a client accreditation test
    • Manage system settings
      • How to change the wizard workflow
      • How to configure the registration wizard
        • How to add a phone number
        • How to add a phone number confirmation step
        • How to add first and last names
      • How to block registration for a country
      • How to add Google ReCaptcha
      • How to add a B2BinPay API key to the B2Core Back Office
      • How to add or remove a language
      • How to create a request resolution type
      • How to create a request resolution
      • How to set up event notifications
      • How to set up Apple push notifications
      • How to add a user group and grant permissions
      • How to add an admin user
      • How to make an admin user see only specific clients
      • How to create a bulk action
      • How to export a CSV file with email addresses
      • How to manage calendar events
        • How to create an event
        • How to update or remove an event
      • How to change Back Office images
      • How to set up 2FA
        • How to set up 2FA with SMS
          • How to create a template for delivering 2FA codes via SMS
          • How to check configuration of the wizards related to 2FA with SMS
          • How to test operation of 2FA with SMS
      • How to import client-related data
      • How to import data related to Back Office user groups
    • Manage trading platforms
      • How to integrate B2Trader
        • How to create a platform for B2Trader
        • How to create a product group for B2Trader
        • How to create a product for B2Trader
      • How to integrate Match-Trader
        • How to create a platform for Match-Trader
        • How to create a product for Match-Trader
        • How to create Match-Trader accounts for clients
        • How to archive Match-Trader accounts
      • How to integrate OneZero and PrimeXM
        • How to create a platform for OneZero
        • How to create a platform for PrimeXM
        • How to create products for OneZero and PrimeXM
        • How to create OneZero and PrimeXM accounts for clients
    • Manage communication platforms
      • How to configure Twilio
        • How to sign up with Twilio
        • How to configure Twilio as a 2FA SMS provider
        • How to configure Twilio as a phone service provider
        • How to test the Twilio phone service operation
      • How to set up a Slack bot
      • How to set up a Telegram bot
      • How to get Telegram chat, group and channel identifiers
    • Manage Acrobat Sign templates
      • How to register and set up an Acrobat Sign profile
      • How to configure a connection to Acrobat Sign
      • How to create Acrobat Sign templates and upload them to B2Core
        • How to create an Acrobat Sign template
        • How to set up form fields added to a document template
        • How to upload Acrobat Sign templates to the B2Core Back Office
      • How to send a document for signature
  • B2Core API
    • REST API
      • Overview
        • HTTP headers
        • HTTP methods
        • HTTP response codes
        • Query parameters
        • Date and time formats
      • The Back Office API
        • Authentication
          • Sign in to the Back Office
          • Confirm a 2FA verification code
          • Refresh the access token
          • Sign out of the Back Office
        • Two-factor authentication
          • Check 2FA status
          • Get 2FA method details
          • Disable 2FA
          • Get 2FA change history
          • Get 2FA change details
        • Authorization history
          • Get authorization history
          • Get authorization details
        • Accounts
          • Get an account list
          • Get account details
          • Create a new account
          • Update an account
          • Get account preferences
          • Get account balance
          • Change account balance
          • Archive an account
        • Addresses
          • Get a list of client addresses
          • Get client address details
          • Add a client address
          • Update a client address
          • Delete a client address
        • Antifraud procedures
          • Get a list of antifraud procedures
          • Get antifraud procedure details
          • Create an antifraud procedure
          • Update an antifraud procedure
          • Delete an antifraud procedure
        • Banners
          • Get a list of banners
          • Get banner details
          • Create a new banner
          • Update a banner
          • Delete a banner
        • Black and White lists
          • Get a list of security policies
          • Get security policy details
          • Create a new security policy
          • Update a security policy
          • Delete a security policy
        • Blocked clients
          • Get a list of blocked clients
          • Get blocked client details
          • Unblock a client
        • Bonuses
          • Get a list of bonuses
          • Get bonus details
          • Create a bonus
          • Update a bonus
          • Delete a bonus
          • Extend a bonus
          • Hold a bonus
          • Reactivate a bonus
          • Revoke a bonus
          • Get a list of bonus presets
          • Get bonus preset details
          • Create a bonus preset
          • Update a bonus preset
          • Delete a bonus preset
          • Get a list of temporary bonuses
          • Get temporary bonus details
          • Create a temporary bonus
          • Update a temporary bonus
          • Delete a temporary bonus
        • Calendar events
          • Get a list of calendar events
          • Get calendar event details
          • Add a calendar event
          • Update a calendar event
          • Delete a calendar event
        • Clients
          • Get a client list
          • Get client details
          • Create a client profile
          • Update a client profile
          • Remove a client profile
        • Client files
          • Get a list of client files
          • Upload a client file
          • Update a client file
          • Delete a client file
          • Create a new client folder
          • Update a client folder
          • Delete a client folder
        • Client folders
          • Get a list of folders
          • Get folder details
          • Add a new folder
          • Add a new subdirectory
          • Update a folder
          • Get granted access permissions
          • Update access permissions
        • Client managers
          • Get a list of managers
          • Get manager details
          • Create a manager profile
          • Update a manager profile
          • Remove a manager profile
        • Client permissions
          • Get a list of permission levels
          • Get permission level details
          • Create a new permission level
          • Update a permission level
          • Delete a permission level
          • Get client permissions
          • Update client permissions
        • Client settings
          • Get client limits
          • Get client settings
          • Update client limits
          • Update client settings
        • Client tags
          • Get a list of tags
          • Get tag details
          • Add a new tag
          • Update a tag
          • Delete a tag
        • Client tests
          • Get a list of client tests
          • Get client test details
          • Create a client test
          • Update a client test
          • Delete a client test
          • Get a list of test’s questions
          • Get test’s question details
          • Add a question to a client test
          • Update a test’s question
          • Delete a test’s question
          • Get a list of answer options
          • Get answer option details
          • Add an answer option
          • Update an answer option
          • Delete an answer option
          • Get a list of completed tests
          • Get completed test details
        • Client types
          • Get a list of client types
          • Get client type details
          • Create a client type
          • Update a client type
          • Delete a client type
        • Confirmations
          • Get a list of SMS providers
          • Get SMS provider details
          • Get a list of SMS provider names
          • Get the configuration settings of an SMS provider
          • Add an SMS provider
          • Update an SMS provider
          • Delete an SMS provider
          • Get a list of confirmation templates
          • Get confirmation template details
          • Create a confirmation template
          • Update a confirmation template
          • Delete a confirmation template
        • Countries
          • Get a list of countries
          • Get country details
          • Update a country
        • Currencies
          • Get a list of currencies
          • Get currency details
          • Add a currency
          • Update a currency
          • Delete a currency
        • Currency aliases
          • Get a list of currency aliases
          • Get currency alias details
          • Add a currency alias
          • Update a currency alias
          • Delete a currency alias
        • Currency pairs
          • Get a list of currency pairs
          • Get currency pair details
          • Add a currency pair
          • Update a currency pair
          • Delete a currency pair
        • Deposits
          • Make a deposit
        • Deposit methods
          • Get a list of deposit groups
          • Get deposit group details
          • Create a deposit group
          • Update a deposit group
          • Delete a deposit group
          • Get a list of deposit methods
          • Get deposit method details
          • Create a deposit method
          • Update a deposit method
          • Delete a deposit method
          • Get a list of deposit commissions
          • Get Deposit commission details
          • Add a deposit commission
          • Update a deposit commission
          • Delete a deposit commission
          • Get a list of deposit currencies
          • Get Deposit currency details
          • Add a deposit currency
          • Update a deposit currency
          • Delete a deposit currency
          • Get a list of deposit method attributes
          • Get deposit method attribute details
          • Add a deposit method attribute
          • Delete a deposit method attribute
          • Get a list of deposit method restrictions
          • Get deposit method restriction details
          • Add a new deposit method restriction
          • Update a deposit method restriction
          • Delete a deposit method restriction
        • Devices
          • Get a list of devices
          • Get device details
          • Delete a device
        • Documents
          • Get a list of documents
          • Get document details
          • Add a new document
          • Delete a document
        • Document types
          • Get a list of document types
          • Get document type details
          • Create a new document type
          • Update a document type
          • Delete a document type
        • Document groups
          • Get a list of document groups
          • Get document group details
          • Create a new document group
          • Update a document group
          • Delete a document group
        • Emails
          • Get a list of email delivery services
          • Get email delivery service details
          • Add an email delivery service
          • Update an email delivery service configuration
          • Delete an email delivery service configuration
          • Get a list of email templates
          • Get email template details
          • Create an email template
          • Update an email template
          • Delete an email template
          • Get a list of sent emails
          • Get sent email details
          • Send an email
          • Delete a sent email
        • Email notification templates
          • Get a list of email notification templates
          • Get email notification template details
          • Create a new email notification template
          • Update an email notification template
          • Delete an email notification template
          • Get a list of notification types
          • Get notification type details
          • Create a new notification type
          • Update a notification type
          • Delete a notification type
        • Event notifications
          • Get a list of events types
          • Get a list of event notifications
          • Get event notification details
          • Create a new event notification
          • Update an event notification
          • Delete an event notification
          • Get a list of event listeners
          • Get event listener details
          • Add a new event listener
          • Update an event listener
          • Delete an event listener
          • Get an event types list
          • Get a list of event handlers
          • Get a list of event handler workflows
        • Exchange rate providers
          • Get an exchange rate for a currency pair
          • Get a list of exchange rate providers
          • Get exchange rate provider details
          • Validate the connection to an exchange rate provider
          • Add an exchange rate provider
          • Update an exchange rate provider
          • Delete an exchange rate provider
        • Exchanges
          • Exchange currencies
        • External connections
          • Get a list of external connections
          • Get external connection details
          • Create a new external connection
          • Update an external connection
          • Delete an external connection
          • Get a list of providers
          • Get provider connection details
        • File storage
          • Get a list of data storage systems
          • Get data storage system details
          • Validate the connection to a data storage system
          • Update data storage system details
        • Key-value storage
          • Get a list of key-value pairs
          • Get key-value pair details
          • Create a key-value pair
          • Update a key-value pair
          • Delete a key-value pair
          • Get a list of key storage tags
          • Get key storage tag details
          • Create a key storage tag
          • Update a key storage tag
          • Delete a key storage tag
        • Localizations
          • Get a list of localization options
          • Get localization option details
          • Update a localization option
        • Menu items
          • Get a menu tree
          • Get menu item details
          • Update a menu item
        • Paid services
          • Get a list of subscriptions
          • Get subscription details
          • Create a subscription
          • Update a subscription
          • Delete a subscription
          • Get a list of paid-service groups
          • Get paid-service group details
          • Create a paid-service group
          • Update a paid-service group
          • Delete a paid-service group
          • Get a list of paid-service parameters
          • Get paid-service parameter details
          • Add a paid-service parameter
          • Update a paid-service parameter
          • Delete a paid-service parameter
          • Get a list of parameter presets
          • Get parameter preset details
          • Create a parameter preset
          • Update a parameter preset
          • Delete a parameter preset
          • Get a list of paid services
          • Get paid service details
          • Add a paid service
          • Update a paid service
          • Delete a paid service
        • Passwords
          • Change a client password
          • Get a password change history
          • Get password change details
          • Prompt all clients to reset their passwords
          • Prompt a specific client to reset their password
        • Phone numbers
          • Get a list of phone numbers
          • Get phone number details
          • Add a new phone number
          • Update a phone number
          • Delete a phone number
        • Products
          • Get a list of products
          • Get product details
          • Create a new product
          • Update a product
          • Delete a product
          • Get a list of product groups
          • Get product group details
          • Create a new product group
          • Update a product group
          • Delete a product group
          • Get a list of product currencies
          • Get product currency details
          • Add a new product currency
          • Update a product currency
          • Delete a product currency
          • Get a list of product notes
          • Get product note details
          • Add a new product note
          • Update a product note
          • Delete a product note
          • Get a list of product restrictions
          • Get product restriction details
          • Add a new product restriction
          • Update a product restriction
          • Delete a product restriction
        • Product permission groups
          • Get a list of permission groups
          • Get permission group details
          • Create a permission group
          • Update a permission group
          • Delete a permission group
        • Profile changes
          • Get a profile change history
          • Get profile change details
        • Profile photos
          • Get a client profile photo
          • Upload a client profile photo
          • Delete a client profile photo
        • Requests
          • Get a list of requests
          • Get request details
          • Update a request
          • Audit a request
          • Approve a request
          • Reject a request
          • Get request notifications
        • Resolutions
          • Get a list of resolutions
          • Get resolution details
          • Add a new resolution
          • Update a resolution
          • Delete a resolution
          • Get a list of resolution types
          • Get resolution type details
          • Add a new resolution type
          • Update a resolution type
          • Delete a resolution type
        • SMTP service providers
          • Get a list of SMTP service providers
          • Get SMTP service provider details
          • Validate an SMTP service provider connection
          • Configure a new SMTP service provider connection
          • Update an SMTP service provider connection
          • Delete an SMTP service provider
        • System logs
          • Get a list of system logs
          • Get system log details
        • Transactions
          • Get a list of transactions
          • Get transaction details
          • Update a transaction
          • Get a list of transaction types
          • Get transaction type details
          • Update a transaction type
          • Submit a transaction monitoring request
          • Get a list of transaction monitoring results
          • Get transaction monitoring details
        • Transfers
          • Transfer funds between accounts
        • Twilio
          • Get the access token for making Twilio phone calls
        • Users
          • Get a list of users
          • Get user details
          • Create a new user
          • Update user information
          • Delete a user
        • User groups
          • Get a list of user groups
          • Get user group details
          • Create a new user group
          • Update a user group
          • Delete a user group
        • Verification history
          • Get verification history
          • Get verification details
        • Verification levels
          • Get a list of verification levels
          • Get verification level details
          • Create a new verification level
          • Update a verification level
          • Delete a verification level
          • Get a list of verification level restrictions
          • Get verification level restriction details
          • Add a verification level restriction
          • Update a verification level restriction
          • Delete a verification level restriction
        • Whitelisted withdrawal addresses
          • Get a list of whitelisted withdrawal addresses
          • Get whitelisted withdrawal address details
        • Widgets
          • Get a list of widgets
          • Get widget details
          • Update a widget
          • Get a list of tickers
          • Get ticker details
          • Get a list of ticker symbols
          • Get ticker symbol details
          • Add a new ticker symbol
          • Delete a ticker symbol
        • Withdrawals
          • Make a withdrawal
        • Withdrawal methods
          • Get a list of withdrawal groups
          • Get withdrawal group details
          • Create a withdrawal group
          • Update a withdrawal group
          • Delete a withdrawal group
          • Get a list of withdrawal methods
          • Get withdrawal method details
          • Create a withdrawal method
          • Update a withdrawal method
          • Delete a withdrawal method
          • Get a list of withdrawal commissions
          • Get withdrawal commission details
          • Add a withdrawal commission
          • Update a withdrawal commission
          • Delete a withdrawal commission
          • Get a list of withdrawal currencies
          • Get withdrawal currency details
          • Add a withdrawal currency
          • Update a withdrawal currency
          • Delete a withdrawal currency
          • Get a list of withdrawal method attributes
          • Get withdrawal method attribute details
          • Add a withdrawal method attribute
          • Delete a withdrawal method attribute
          • Get a list of withdrawal method restrictions
          • Get withdrawal method restriction details
          • Add a withdrawal method restriction
          • Update a withdrawal method restriction
          • Delete a withdrawal method restriction
        • Withdrawal templates
          • Get a list of withdrawal templates
          • Get withdrawal template details
        • Back Office API objects
          • The Answer Option object (Back Office)
          • The Account object (Back Office)
          • The Address object (Back Office)
          • The Antifraud Procedure object (Back Office)
          • The Authorization Record object (Back Office)
          • The Banner object (Back Office)
          • The Bonus object (Back Office)
          • The Bonus Preset object (Back Office)
          • The Calendar Event object (Back Office)
          • The Client object (Back Office)
          • The Client Folder object (Back Office)
          • The Client Limits object (Back Office)
          • The Client Manager object (Back Office)
          • The Client Settings object (Back Office)
          • The Client Test object (Back Office)
          • The Client Type object (Back Office)
          • The Completed Test object (Back Office)
          • The SMS Provider object (Back Office)
          • The Confirmation Template object (Back Office)
          • The Country object (Back Office)
          • The Currency object (Back Office)
          • The Currency Alias object (Back Office)
          • The Currency Pair object (Back Office)
          • The Deposit Commission (Back Office)
          • The Deposit Currency object (Back Office)
          • The Deposit Group object (Back Office)
          • The Deposit Method object (Back Office)
          • The Deposit Method Attribute object (Back Office)
          • The Deposit Method Restriction object (Back Office)
          • The File Storage object (Back Office)
          • The Key-Value Pair object (Back Office)
          • The Key-Value Tag object (Back Office)
          • The Device object (Back Office)
          • The Document object (Back Office)
          • The Document Type object (Back Office)
          • The Document Group object (Back Office)
          • The Email Delivery Service object (Back Office)
          • The SMTP Service Provider object (Back Office)
          • The Notification Type object (Back Office)
          • The Email Notification Template object (Back Office)
          • The Email Template object (Back Office)
          • The Event Listener object (Back Office)
          • The Event Notification object (Back Office)
          • The Exchange Rate Provider object (Back Office)
          • The External Connection object (Back Office)
          • The Localization object (Back Office)
          • The Menu Item object (Back Office)
          • The Paid Service object (Back Office)
          • The Paid-Service group object (Back Office)
          • The Paid-Service parameter object (Back Office)
          • The Parameter Preset object (Back Office)
          • The Permission Level object (Back Office)
          • The Phone Number object (Back Office)
          • The Product object (Back Office)
          • The Product Currency object (Back Office)
          • The Product Group object (Back Office)
          • The Product Note object (Back Office)
          • The Product Permission Group object (Back Office)
          • The Product Restriction object (Back Office)
          • The Profile Change object (Back Office)
          • The Request object (Back Office)
          • The Resolution object (Back Office)
          • The Resolution Type object (Back Office)
          • The Security Policy object (Back Office)
          • The Sent Email object (Back Office)
          • The Subscription object (Back Office)
          • The System Log object (Back Office)
          • The Test’s Question object (Back Office)
          • The Temporary Bonus object (Back Office)
          • The Transaction object (Back Office)
          • The Transaction Type (Back Office)
          • The Transaction Monitoring object (Back Office)
          • The User object (Back Office)
          • The User Group object (Back Office)
          • The Statement object (Back Office)
          • The Tag object (Back Office)
          • The Verification Level object (Back Office)
          • The Verification Level Restriction object (Back Office)
          • The Whitelisted Address object (Back Office)
          • The Widget object (Back Office)
          • The Withdrawal Commission (Back Office)
          • The Withdrawal Currency object (Back Office)
          • The Withdrawal Group object (Back Office)
          • The Withdrawal Method object (Back Office)
          • The Withdrawal Method Attribute object (Back Office)
          • The Withdrawal Method Restriction object (Back Office)
          • The Withdrawal Template object (Back Office)
      • The Front Office API
        • Get started
        • Obtain a device fingerprint
        • Registration
          • Initialize the Sign Up Wizard
          • Sign up to the B2Core UI
        • Authentication
          • Initialize the Sign In Wizard
          • Sign in to the B2Core UI
          • Refresh the access token
          • Sign out of the B2Core UI
        • Two-factor authentication
          • Choose a 2FA method
          • Use Google Authenticator to secure access to the B2Core UI
          • Use an SMS code to secure access to the B2Core UI
          • Initiate a 2FA procedure for an authorized client
          • Initiate a 2FA procedure for an unauthorized client
          • Complete the initiated 2FA procedure
          • Check 2FA status
          • Get 2FA method details
          • Initialize a wizard for enabling 2FA
          • Initialize a wizard for disabling 2FA
          • Enable or disable 2FA
            • Enable 2FA with Google Authenticator
            • Enable 2FA with SMS
            • Disable 2FA
          • Get 2FA change history
          • Get 2FA change details
        • Accounts
          • Get a list of client accounts
          • Get client account details
          • Create a new account
          • Archive an account
          • Update an account
          • Initialize the wizard for changing a trading account password
          • Confirm a procedure of changing a trading account password
          • Change a trading account password
          • Restore a trading account password
        • Anti-phishing codes
          • Get an anti-phishing code
          • Set an anti-phishing code
          • Remove an anti-phishing code
          • Choose a 2FA method
          • Confirm setting or removing an anti-phishing code
        • Apple device tokens
          • Add an Apple device token
          • Delete an Apple device token
        • Authorization history
          • Get authorization history
          • Get authorization details
        • Banners
          • Get a list of banners
          • Get banner details
        • Bonuses
          • Get a list of bonuses
          • Get bonus details
          • Get a list of temporary bonuses
          • Get temporary bonus details
          • Claim a temporary bonus
        • Charts
          • Get charts data
        • Client permissions
          • Get client permissions
        • Client profiles
          • Get client profile data
          • Initialize client profile deactivation
          • Confirm client profile deactivation
          • Update client profile data
        • Client settings
          • Get client settings
          • Update client settings
        • Client tests
          • Get a list of client tests
          • Get client test details
          • Get completed client tests
          • Submit answers to test’s questions
        • Client types
          • Get a list of client types
          • Get client type details
        • Countries
          • Get a list of countries
          • Get country details
        • Currencies
          • Get currency rates
          • Get an exchange rate for a currency pair
          • Get a list of paired currencies
          • Exchange currencies
        • Help desk tickets
          • Get a list of tickets
          • Get ticket details
          • Get ticket fields
          • Submit a ticket
          • Close a ticket
          • Reopen a ticket
          • Get a list of messages
          • Send a message
          • Download ticket attachments
        • Deposits
          • Make a synchronous deposit
          • Make an asynchronous deposit
        • Deposit methods
          • Get a list of deposit methods
          • Get deposit method details
          • Get a list of deposit groups
          • Get a list of currencies added to deposit methods
        • Devices
          • Get a list of devices
          • Get device details
          • Delete a device
        • Documents
          • Get a list of documents
          • Get document details
          • Add a new document
          • Delete a document
        • Key-value storage
          • Get a list of key-value pairs
          • Get key-value pair details
        • Localizations
          • Get a list of localization options
          • Get localization option details
        • Menu items
          • Get a menu tree
          • Get menu item details
        • Passwords
          • Change a client password
          • Restore a client password
          • Get a password change history
          • Get password change details
        • Product currencies
          • Get a list of product currencies
          • Get product currency details
        • Product groups
          • Get a list of product groups
          • Get product group details
        • Product notes
          • Get a list of product notes
          • Get product note details
        • Profile photos
          • Get a client profile photo
          • Upload a client profile photo
          • Delete a client profile photo
        • The mobile app settings
          • Get the mobile app settings
        • Trading platforms
          • Obtain the access token
          • Refresh the access token
        • Transactions
          • Get a list of client transactions
          • Get transaction details
        • Transfers
          • Transfer funds between accounts
        • Verification procedures
          • Get verification history
          • Get verification details
          • Initialize a wizard for running a verification procedure
          • Run a verification procedure
        • Verification levels
          • Get a list of verification levels
          • Get verification level details
        • Whitelisted withdrawal addresses
          • Get a list of whitelisted withdrawal addresses
          • Get whitelisted withdrawal address details
          • Get a list of currencies for withdrawing funds to whitelisted withdrawal addresses
          • Initialize the wizard for creating a withdrawal address whitelist
          • Add a withdrawal address to a whitelist
          • Initialize the wizard for removing a withdrawal address from a whitelist
          • Remove a withdrawal address from a whitelist
          • Enable the address management option
          • Initialize the wizard for disabling the address management option
          • Disable the address management option
          • Confirm an initialized procedure
        • Widgets
          • Get a list of widgets
          • Get widget details
        • Withdrawals
          • Initialize a wizard for withdrawing funds
          • Make a withdrawal
          • Confirm a withdrawal
        • Withdrawal methods
          • Get a list of withdrawal methods
          • Get withdrawal method details
          • Get a list of withdrawal groups
          • Get a list of currencies added to withdrawal methods
        • Withdrawal templates
          • Get a list of withdrawal templates
          • Get withdrawal template details
          • Create a withdrawal template
          • Update a withdrawal template
          • Delete a withdrawal template
        • Front Office API objects
          • The Account object (Front Office)
          • The Authorization Record object (Front Office)
          • The Banner object (Front Office)
          • The Bonus object (Front Office)
          • The Client Profile (Front Office)
          • The Client Settings object (Front Office)
          • The Client Type object (Front Office)
          • The Country object (Front Office)
          • The Currency object (Front Office)
          • The Deposit Group object (Front Office)
          • The Deposit Method object (Front Office)
          • The Device object (Front Office)
          • The Document object (Front Office)
          • The Key-Value Pair object (Front Office)
          • The Localization object (Front Office)
          • The Menu Item object (Front Office)
          • The Product Currency object (Front Office)
          • The Product Group (Front Office)
          • The Product Note object (Front Office)
          • The Statement object (Front Office)
          • The Temporary Bonus object (Front Office)
          • The Ticket object (Front Office)
          • The Transaction object (Front Office)
          • The Verification Level object (Front Office)
          • The Whitelisted Address object (Front Office)
          • The Widget object (Front Office)
          • The Withdrawal Group object (Front Office)
          • The Withdrawal Method object (Front Office)
          • The Withdrawal Template object (Front Office)
    • WebSocket API
      • Connect to a WebSocket server
      • Subscribe to the user events channel
  • B2Core Mobile
    • Deploying your iOS app
      • Step 1. Prepare the licenses for trading crypto
      • Step 2. Create and configure a demo account in the B2Core UI
      • Step 3. Enroll in the Apple Developer Program as an Organization
      • Step 4. Grant the access and admin permissions to the B2Core team
      • Step 5. Provide all necessary information to your Account Manager
      • Step 6. Specify the pricing, availability and privacy options
      • Step 7. Specify a demo account from which the Apple Review team will log in
    • Deploying your Android app
      • Step 1. Create and configure a demo account in the B2Core UI
      • Step 2. Create a Google Play developer account
      • Step 3. Grant the access and admin permissions to the B2Core team
      • Step 4. Create and set up your app
      • Step 5. Provide all necessary information to your Account Manager
Home B2Core API REST API The Back Office API Paid services

Paid services

Use these methods to manage the paid services to which clients can be subscribed, as well as manage clients’ subscriptions.

GET[host]api/v2/subscriptions

Get a list of subscriptions

GET[host]/api/v2/subscriptions/{subscriptionId}

Get subscription details

POST[host]/api/v2/subscriptions

Create a subscription

PUT[host]/api/v2/subscriptions/{subscriptionId}

PATCH[host]/api/v2/subscriptions/{subscriptionId}

Update a subscription

DELETE[host]/api/v2/subscriptions/{subscriptionId}

Delete a subscription

GET[host]/api/v2/subscriptions/groups

Get a list of paid-service groups

GET[host]/api/v2/subscriptions/groups/{groupId}

Get paid-service group details

POST[host]/api/v2/subscriptions/groups

Create a paid-service group

PATCH[host]/api/v2/subscriptions/groups/{groupId}

Update a paid-service group

DELETE[host]/api/v2/subscriptions/groups/{groupId}

Delete a paid-service group

GET[host]/api/v2/subscriptions/parameters

Method Get a list of paid-service parameters

GET[host]/api/v2/subscriptions/parameters/{parameterId}

Get paid-service parameter details

POST[host]/api/v2/subscriptions/parameters

Add a paid-service parameter

PATCH[host]/api/v2/subscriptions/parameters/{parameterId}

Update a paid-service parameter

DELETE[host]/api/v2/subscriptions/parameters/{parameterId}

Delete a paid-service parameter

GET[host]/api/v2/v2/subscriptions/plans

Get a list of parameter presets

GET[host]/api/v2/subscriptions/plans/{planId}

Get parameter preset details

POST[host]/api/v2/subscriptions/plans

Create a parameter preset

PATCH[host]/api/v2/subscriptions/plans/{planId}

Update a parameter preset

DELETE[host]/api/v2/subscriptions/plans/{planId}

Delete a parameter preset

GET[host]/api/v2/subscriptions/services

Get a list of paid services

GET[host]/api/v2/subscriptions/services/{serviceId}

Get paid service details

POST[host]/api/v2/subscriptions/services

Add a paid service

PATCH[host]/api/v2/subscriptions/services/{serviceId}

Update a paid service

DELETE[host]/api/v2/subscriptions/services/{serviceId}

Delete a paid service

Get a list of subscriptions

Use this method to obtain a list of paid services to which clients are subscribed.

Request

Header parameters:

  • Authorization: Bearer <token>

Query parameters:

The following filter parameters are available for this method:

clientId

The client identifier.

serviceId

The identifier of a paid service.

isActive

If 1, the subscription to a paid service is active; otherwise, 0.

The following sorting parameter is available for this method:

createTime

The date and time when a client was subscribed to a paid service.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]api/v2/subscriptions

curl --location -g 'https://host.name/api/v2/subscriptions?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[clientId]=1&filter[serviceId]=1&filter[isActive]=1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains an array of Subscription objects providing information about the subscriptions matching the request parameters.


Get subscription details

Use this method to obtain detailed information about a specific paid service to which a client is subscribed.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

subscriptionId required

The subscription identifier.

GET[host]/api/v2/subscriptions/{subscriptionId}

curl --location 'https://host.name/api/v2/subscriptions/1' \
--header 'Authorization: Bearer <token>'

Response

A response contains a Subscription object providing information about the specified subscription.


Create a subscription

Use this method to subscribe a client to a paid service.

Request

Header parameters:

  • Authorization: Bearer <token>

Body:

Specify the following parameters for a new subscription:

clientId integer required

The client identifier.

serviceId integer required

The identifier of a paid service to which you want to subscribe a client.

isActive integer required

If 1, the subscription to a paid service is active; otherwise, 0.

parameters object

The parameters that you want to specify for the subscription.

POST[host]/api/v2/subscriptions

curl --location --request POST 'https://host.name/api/v2/subscriptions' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "clientId": 1,
  "serviceId": 1,
  "isActive": 0,
  "parameters": {}
}'

Response

A response contains a Subscription object providing information about the created subscription.


Update a subscription

Use this method to update a specified subscription to a paid service.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

subscriptionId required

The subscription identifier.

Body:

The following field values can be updated for a specified subscription:

isActive integer

If 1, the subscription to a paid service is active; otherwise, 0.

parameters object

The parameters that you want to specify for the subscription.

PATCH[host]/api/v2/subscriptions/:path-param:`{subscriptionId}

curl --location --request PATCH 'https://host.name/api/v2/subscriptions/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "isActive": 1,
  "parameters": {}
}'

Response

A response contains a Subscription object providing information about the subscription that was updated.


Delete a subscription

Use this method to unsubscribe a client from a specified paid service.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

subscriptionId required

The subscription identifier.

DELETE[host]/api/v2/subscriptions/{subscriptionId}

curl --location --request DELETE 'https://host.name/api/v2/subscriptions/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.

Get a list of paid-service groups

Use this method to obtain a list of groups that are used to categorize paid services.

Request

Header parameters:

  • Authorization: Bearer <token>

Query parameters:

The following filter parameters are available for this method:

caption

The name of a paid-service group.

comment

The internal description of a paid-service group.

The following sorting parameter is available for this method:

id

The identifier of a paid-service group.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/subscriptions/groups

curl --location -g 'https://host.name/api/v2/subscriptions/groups?limit=10&offset=0&sort_order=desc&sort_by=id&filter[caption]=Caption&filter[comment]=Comment' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains an array of Paid-Service group objects providing information about the groups matching the request parameters.


Get paid-service group details

Use this method to obtain detailed information about a specified paid-service group.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

groupId required

The identifier of a paid-service group.

GET[host]/api/v2/subscriptions/groups/{groupId}

curl --location 'https://host.name/api/v2/subscriptions/groups/1' \
--header 'Authorization: Bearer <token>'

Response

A response contains a Paid-Service group object providing information about the specified group.


Create a paid-service group

Use this method to create a new paid-service group.

Request

Header parameters:

  • Authorization: Bearer <token>

Body:

Specify the following parameters for a new group:

caption string required

The name of a paid-service group.

comment string

The internal description of a paid-service group.

POST[host]/api/v2/subscriptions/groups

curl --location --request POST 'https://host.name/api/v2/subscriptions/groups' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "caption": "The group description",
  "comment": "The group name"
}'

Response

A response contains a Paid-Service group object providing information about the created group.


Update a paid-service group

Use this method to update a specified paid-service group.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

groupId required

The identifier of a paid-service group.

Body:

The following field values can be updated for a group:

caption string

The name of a paid-service group.

comment string

The internal description of a paid-service group.

PATCH[host]/api/v2/subscriptions/groups/{groupId}

curl --location --request PATCH 'https://host.name/api/v2/subscriptions/groups/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "caption": "The group name",
  "comment": "The group description"
}'

Response

A response contains a Paid-Service group object providing information about the group that was updated.


Delete a paid-service group

Use this method to delete a specified paid-service group.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

groupId required

The identifier of a paid-service group.

DELETE[host]/api/v2/subscriptions/groups/{groupId}

curl --location --request DELETE 'https://host.name/api/v2/subscriptions/groups/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.


Get a list of paid-service parameters

Use this method to obtain a list of parameters that can be specified for paid services when subscribing clients to them.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following filter parameters are available for this method:

name

The service parameter name.

caption

The service parameter description.

categoryId

The identifier of a category in which a service parameter is included.

The following sorting parameter is available for this method:

id

The identifier of a service parameter.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/subscriptions/parameters

curl --location -g 'https://host.name/api/v2/subscriptions/parameters?limit=10&offset=0&sort_order=desc&sort_by=id&filter[caption]=Caption&filter[name]=Name&filter[categoryId]=1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains an array of Paid-Service parameter objects providing information about the retrieved service parameters.


Get paid-service parameter details

Use this method to obtain detailed information about a specific parameter that can be defined when subscribing clients to paid services.

Request

Path parameters:

parameterId required

The service parameter identifier.

GET[host]/api/v2/subscriptions/parameters/{parameterId}

curl --location 'https://host.name/api/v2/subscriptions/parameters/1' \
--header 'Authorization: Bearer <token>'

Response

A response contains a Paid-Service parameter object providing information about the specified parameter.


Add a paid-service parameter

Use this method to add a new parameter that can be specified when subscribing clients to paid services.

Request

Header parameters:

  • Authorization: Bearer <token>

Body:

Specify the following parameters:

name string required

The service parameter name.

caption string required

The service parameter description.

categoryId integer required

The identifier of a category in which a parameter is included.

If no category is assigned to a parameter, it can be used by all Back Office users who are allowed to manage paid services.

type string required

The parameter type. Possible values:

  • text

  • numeric

  • date

  • select

  • multiselect

  • checkbox

  • spread_sheet

services array

An array of integer values identifying the paid services for which a parameter can be specified.

settings object

The value options added for a parameter.

POST[host]/api/v2/subscriptions/parameters

curl --location --request POST 'https://host.name/api/v2/subscriptions/parameters' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "name": "Payment period",
  "caption": "The parameter description",
  "categoryId": 1,
  "type": "select",
  "services": [
    1,
    2
  ],
  "settings": {
    "options": [
      "Weekly",
      "Monthly",
      "Quarterly",
      "Yearly",
    ]
  }
}'

Response

A response body includes a Paid-Service parameter object providing information about the added paid-service parameter.


Update a paid-service parameter

Use this method to update a specified paid-service parameter.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

parameterId required

The service parameter identifier.

Body:

The following field values can be updated for a service parameter:

name string

The service parameter name.

caption string

The service parameter description.

categoryId integer

The identifier of a category in which a parameter is included.

If no category is assigned to a parameter, it can be used by all Back Office users who are allowed to manage paid services.

type string

The parameter type. Possible values:

  • text

  • numeric

  • date

  • select

  • multiselect

  • checkbox

  • spread_sheet

services array

An array of integer values identifying the paid services for which a parameter can be specified.

settings object

The value options added for a parameter.

PATCH[host]/api/v2/subscriptions/parameters/{parameterId}

curl --location --request PATCH 'https://host.name/api/v2/subscriptions/parameters/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "name": "Payment period",
  "caption": "The parameter description",
  "categoryId": 1,
  "type": "select",
  "services": [
    1,
    3
  ],
  "settings": {
    "options": [
      "Weekly",
      "Monthly",
      "Quarterly",
    ]
  }
}'

Response

A response includes a Paid-Service parameter object providing information about the parameter that was updated.


Delete a paid-service parameter

Use this method to delete a specified paid-service parameter.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

parameterId required

The service parameter identifier.

DELETE[host]/api/v2/subscriptions/parameters/{parameterId}

curl --location --request DELETE 'https://host.name/api/v2/subscriptions/parameters/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.


Get a list of parameter presets

Use this method to obtain a list of saved parameter presets.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following filter parameters are available for this method:

name

The name of a parameter preset.

serviceId

The identifier of a paid service for which a parameter preset can be applied.

The following sorting parameter is available for this method:

createTime

The date and time when a parameter preset was saved.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/v2/subscriptions/plans

curl --location -g 'https://host.name/api/v2/subscriptions/plans?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[name]=Name&filter[serviceId]=1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains an array of Parameter Preset objects providing information about the presets matching the request parameters.


Get parameter preset details

Use this method to obtain detailed information about a specific parameter preset.

Request

Path parameters:

planId required

The identifier of a parameter preset.

GET[host]/api/v2/subscriptions/plans/{planId}

curl --location -g 'https://host.name/api/v2/subscriptions/plans/1' \
--header 'Authorization: Bearer <token>'

Response

A response contains a Parameter Preset object providing information about the specified preset.


Create a parameter preset

Use this method to create a new parameter preset.

Request

Header parameters:

  • Authorization: Bearer <token>

Body:

Specify the following parameters when adding a parameter preset:

name string required

The name of a parameter preset.

serviceId integer required

The identifier of a paid service to which a parameter preset can be applied.

data object

The details about the parameters included in a preset.

POST[host]/api/v2/subscriptions/plans

curl --location --request POST 'https://host.name/api/v2/subscriptions/plans' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "name": "Name",
  "serviceId": 1,
  "data": {}
}'

Response

A response body includes a Parameter Preset object providing information about the added preset.


Update a parameter preset

Use this method to update a specified parameter preset.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

planId required

The identifier of a parameter preset.

Body:

The following field values can be updated for a parameter preset:

name string

The name of a parameter preset.

PATCH[host]/api/v2/subscriptions/plans/{planId}

curl --location --request PATCH 'https://host.name/api/v2/subscriptions/plans/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "name": "Name"
}'

Response

A response includes a Parameter Preset object providing information about the preset that was updated.


Delete a parameter preset

Use this method to delete a parameter preset.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters

planId required

The identifier of a parameter preset.

DELETE[host]/api/v2/subscriptions/plans/{planId}

curl --location --request DELETE 'https://host.name/api/v2/subscriptions/plans/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.


Get a list of paid services

Use this method to obtain a list of paid services to which clients can be subscribed.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following filter parameters are available for this method:

name

The name of a paid service.

externalId

The identifier of an external service provider.

fullName

The full name of a paid service.

groupId

The identifier of a group in which a paid service is included.

isActive

If 1, a paid service is enabled, and clients can be subscribed to it; otherwise, 0.

comment

The internal description of a paid service.

The following sorting parameter is available for this method:

creteTime

The date and time when a paid service was configured in the Back Office.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/subscriptions/services

curl --location -g 'https://host.name/api/v2/subscriptions/services?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[name]=Name&filter[externalId]=1&filter[fullName]=Name&filter[groupId]=1&filter[isActive]=&filter[comment]=Comment' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains an array of Paid Service objects providing information about the paid services matching the request parameters.


Get paid service details

Use this method to obtain detailed information about a specified paid service.

Request

Path parameters:

serviceId required

The identifier of a paid service.

GET[host]/api/v2/subscriptions/services/{serviceId}

curl --location 'https://host.name/api/v2/subscriptions/services/1' \
--header 'Authorization: Bearer <token>'

Response

A response contains a Paid Service object providing information about a specified paid service.


Add a paid service

Use this method to add a new paid service to which clients can be subscribed.

Request

Header parameters:

  • Authorization: Bearer <token>

Body:

Specify the following parameters when adding a paid service:

name string required

The name of a paid service.

fullName string required

The full name of a paid service.

groupId integer required

The identifier of a group in which a paid service is included.

isActive integer required

If 1, a paid service is enabled, and clients can be subscribed to it; otherwise, 0.

externalId string

The identifier of an external service provider.

comment string

The internal description of a paid service.

POST[host]/api/v2/subscriptions/services

curl --location --request POST 'https://host.name/api/v2/subscriptions/services' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "name": "The service name",
  "fullName": "The full service name",
  "groupId": 1,
  "isActive": 0,
  "externalId": "15",
  "comment": "The service description"
}'

Response

A response body includes a Paid Service object providing information about the added paid service.


Update a paid service

Use this method to update a paid service.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

serviceId required

The identifier of a paid service.

Body:

The following field values can be updated for a paid service:

name string

The name of a paid service.

externalId string

The identifier of an external service provider.

fullName string

The full name of a paid service.

comment string

The internal description of a paid service.

groupId integer

The identifier of a group in which a paid service is included.

isActive integer

If 1, a paid service is enabled, and clients can be subscribed to it; otherwise, 0.

PATCH[host]/api/v2/subscriptions/services/{serviceId}

curl --location --request PATCH 'https://host.name/api/v2/subscriptions/services/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "name": "The service name",
  "externalId": "16",
  "fullName": "The full service name",
  "comment": "The service description",
  "groupId": 1,
  "isActive": 1
}'

Response

A response includes a Paid Service object providing information about the paid service that was updated.


Delete a paid service

Use this method to delete a paid service from the Back Office.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters

serviceId required

The identifier of a paid service.

DELETE[host]/api/v2/subscriptions/services/{serviceId}

curl --location --request DELETE 'https://host.name/api/v2/subscriptions/services/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.