Connecting to digital asset exchanges

Use this step-by-step guide to set up your environment to submit payments with RippleNet through On-Demand Liquidity. This guide contains instructions specific to several digital asset exchanges.

Digital asset exchanges may offer multiple account options when you open an account. Each option may limit the amount of trades you can make each month, and the amount you can withdraw from your account on a daily or monthly basis. When opening your account, make sure to select the account option that fits your expected needs for On-Demand Liquidity transactions, and adjust your daily and monthly withdrawal limits in your exchange account's settings to meet those needs on that exchange.

Liquidity paths and supported exchanges

This section describes the liquidity paths, exchanges, supported currencies, and payout methods that On-Demand Liquidity supports across RippleNet.

Exchange minimum and maximum order requirements

Each digital asset exchange may have minimum and/or maximum transaction order amount requirements. If a transaction does not meet these requirements, On-Demand Liquidity will reject the payment transaction, failing the payment with an error.

Set up your environment

Complete the following setup tasks to enable RippleNet to use On-Demand Liquidity:

1. Pre-fund your source exchange account
2. Generate exchange API keys
3. Upload exchange API secret and key to Ripple Payments

1. Pre-fund your source exchange account

Pre-fund your source exchange account to supply sufficient liquidity to fund the payments you submit through RippleNet. The following digital asset exchanges can be set up as your source exchange for On-Demand Liquidity:

• Bitstamp
• BTC Markets
• Independent Reserve

2. Generate exchange API keys

Generate exchange API keys and secrets to enable the RippleNet On-Demand Liquidity service to communicate with your source and destination exchange accounts.

While generating your API keys, take some time to ensure you set the correct daily and monthly transfer/withdrawal limits for your needs on that exchange. If you decide to increase your trade or withdrawal amounts, the exchange may require additional documentation and time to approve that change.

• Bitso
• Bitstamp
• BTC Markets
• Coins.ph
• Independent Reserve
• PDAX

In Bitso:

1. Log in to your Bitso account. Open the user menu in the top right and select Profile .
2. In the left menu, click API .
3. On the "API SETUP" page, click Add new API key . The "Add new API key" page appears.

   

4. Give the API key a name.
5. Enable the following Permissions (if requested):
   • Place orders
   • View balances
   • View account information
   • Make withdrawals
6. Click Add new API key to save your credentials.
7. Copy the Bitso API Secret Bitso generates for your API key and store it in a safe place. You need it when you upload your exchange API key and secret to Ripple Payments .

   Warning

   Bitso only displays your API Secret once.

8. Navigate to your account LIMITS in the left menu of your Profile page, and review your account limits to ensure they meet daily and monthly payments volume estimates required for your use case.

For more information, visit Bitso to learn how to Generate Your API Credentials.

In Bitstamp:

When creating API keys ensure that you don't have more than one API key active for Ripple.

1. Log in to your Bitstamp account and go to Account > Settings > API Access .
2. Withdrawal Address Whitelist: Follow the Bitstamp instructions to disable cryptocurrency withdrawals: https://www.bitstamp.net/account/withdraw/whitelist/ .

   Note

   The withdrawal whitelist instructions are only available if you are logged in with a verified account.

3. Click New API key . The "API access" page displays.
4. Enable the following permissions:

   Withdrawals

   • Open, cancel and view bank withdrawals
   • Create crypto withdrawals
     • Allow for all current and future available assets
   • List withdrawal requests

   Order management

   • View open orders
   • Cancel orders
   • Create buy orders
   • Create sell orders

   General permissions

   • View account balances
   • View your transactions

   Deposits

   • View Ripple deposit address

   

5. Click Create new API key .
6. Save the Secret value in a secure location. You need it when you upload your exchange API key and secret to Ripple Payments .

   Warning

   Bitstamp only displays your Secret once.

7. Click Activate API key . This triggers an email requesting authorization of the activation.
8. To confirm the activation, access your email and click the activation link.

   Note

   Bitstamp activation requires that you complete the email confirmation process.

For more information, see Bitstamp's API authentication.

In BTC Markets:

1. To generate your BTC Markets API access key and secret, log in to your BTC Markets account and navigate to your Account page.
2. Click the API Key link.
3. Click Add new API key .
4. Select Read & Write permissions from the dropdown for each of the three API key actions:
   • Account
   • Fund Transfer
   • Trade
5. Click Submit to generate your BTC Markets API access key and secret. If you have two-factor authentication enabled, enter the Two-Factor Code generated by your Authenticator app.
6. Copy the Private secret BTC Markets generates for your API key and store it in a safe place.

   Warning

   BTC Markets only displays your API Private secret key once.

   You need your key and secret when you upload your exchange API key and secret to Ripple Payments. You can view your Public API Key on your BTC Markets Account API Key page by clicking the "eye" logo next to your Public Key.

When your integration with On-Demand Liquidity is complete and you are ready to make a live test transaction through BTC Markets, contact BTC Markets with an email to compliance@btcmarkets.net. This test transaction will allow BTC Markets to monitor the transaction, ensuring their systems recognize your customer profile.

In Coins.ph:

1. To generate a Coins.ph API key, log in to your Coins.ph account and navigate to your Settings page.
2. In the API Access section, click Go to API Dashboard .
3. From your API Dashboard, click Add New Key . The New API Key form appears.

   

4. Fill out the New API Key form and click Save to create your key:
   • Leave the Enable HMAC box unchecked.
   • In Application Name , give the API key a name, such as On-demand-liquidity .
   • For the Redirect URL , enter https://www.ripple.com .
   • Add a Description for your key (optional).
   • Select the following Permissions :
     • buyorder
     • sellorder
     • history
     • wallet_history
     • wallet_transfer
     • user_identity
5. Copy your API Secret and store it in a safe place.

   Warning

   Coins.ph only displays your secret once.

   You need your public API key and secret when you upload your exchange API key and secret to Ripple Payments. After you create your API key, you can view your API name and public key with the show link on your Coins.ph API Dashboard (API Access page).

6. Disable two-factor authentication (2FA) for your Coins.ph account to allow API withdrawals through On-Demand Liquidity by selecting Disable 2FA and following the prompts from your Coins.ph Account Settings page .
7. Navigate to your account limits at Coins.ph and review your account limits to ensure they meet daily and monthly payments volume estimates required for your use case.

In Independent Reserve

1. To generate an Independent Reserve API Key and Secret, log on to your Independent Reserve account and navigate to the Settings tab.
2. Select the API Keys tab.
3. Click Generate .
4. Fill out the Generate API Key form:
   • Select Full Access for the level of access.
   • Add an API Key Description for your API key, for example "ODL-Key".
   • Next to the lock icon, enter your Independent Reserve account Password and then click save .

   

   Independent Reserve presents your new API Key/Secret combination.

   Warning

   Independent Reserve only displays your API Secret once.

5. Copy your API Key and API Secret combination and store it in a safe place.

   You need your Independent Reserve API Key and API Secret when you upload your exchange API key and secret to Ripple Payments.

   

In PDAX

1. To generate your PDAX API Key, log in to the PDAX Partners portal.

   This site is where institutional account holders create and manage their PDAX API keys and secrets.

2. Click Create / Fetch API Key Pair and then enter the following information to generate your PDAX API Key/Secret combination:
   • Unique Alias

     Tip

     Make a note of the alias you define for your API Key/Secret. After you generate your API Key/Secret, you can retrieve them using this unique alias in the future.

   • OTP - Don't enter any information in this field as it is no longer necessary.
3. Click Create / Fetch . PDAX displays your key/secret combination.
4. Make a note of your PDAX API key and secret. You need them when you upload your exchange API key and secret to Ripple Payments .

   Tip

   You can always return to the PDAX Partners portal and use your Unique Alias to fetch your PDAX API Key and Secret.

3. Upload exchange API secret and key to Ripple Payments UI

To complete setup for sending payments with RippleNet through On-Demand Liquidity, you must add the exchange API key and secret you generated for your exchange account to Ripple Payments.

In Ripple Payments UI:

1. Sign in to Ripple Payments .

   Note

   You need the credentials that your Ripple representative supplied to your institution.

2. From the home page, navigate to the Connections page and click the Exchanges tab.
3. Under Exchanges , click the Add Credentials card.

   The Add Exchange Credentials > Exchange Info screen appears.

   

4. Select the exchange you are adding credentials for, select production for the environment ( testing does not use exchange keys), fill out the fields with your exchange credential information, and click Save .

   Note

   For the Bitstamp exchange, your account name must be the customer ID for your Bitstamp account. There are no requirements for the account name for all other exchanges other than the name must be 32 characters or less in length. Provide an account name that makes sense for your needs.
   The PDAX exchange no longer needs the OTP seed information. In the OTP Seed field, enter xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (32 times).

5. If you need to add additional exchange keys, repeat steps three and four for each key.