API Authentication

To access API from your system you need to whitelist your IP and create access token. Use access token when sending call using Create order or Deposit methods.

Authentication token are created from customer cabinet. Customer ID is displayed in customer cabinet, under company name.

To add an access token, follow the steps outlined below.

  1. Navigate to the Products tab in the left sidebar of your dashboard.

  2. Select the 'Order' option. In this section, you should find a table listing all existing access tokens.

  3. Above this table, look for the 'add' button and click on it, which will bring up a form requiring the following details:

    • Token Name: This is simply a unique identifier for your access token.

    • Token Type: This is the payment method facilitated by the token, chosen from a dropdown menu. For example, if you want to use Binance Pay exclusively, ensure you've activated the auto-exchange feature from your dashboard first. Then, during the token creation process, select Binance Pay as the token type.

    • Currency: Any orders created using this token will default to this selected currency.

    • IP Whitelist: You'll need to specify the IP addresses that will be allowed to make requests. The system will filter requests based on these IPs.

    • Callback URLs: These are the URLs where you'll receive information about the order from Citypay. Make sure to specify all necessary callback URLs.

    • Expiration Date: This refers to the expiry date of the token, given in Unix timestamp format.

Follow these steps carefully to ensure the successful addition of a new access token to your account. After successfully creating the token, it's crucial that you copy and securely store it. Please note that the token will only be displayed once, and you won't be able to retrieve it again.

Last updated