The following document is divided into three parts. Part I describes how to gain access to the swagger documentation, Part II describes how to generate your first token and how to refresh your token and Part III covers the API calls that can be made as well as some implementation tips.
PART I. ACCESS SWAGGER DOCUMENTATION.
The swagger documentation provides an overview of all the methods with their parameters and expected responses.
- Go to https://www.volabit.com/api-docs/
- Enter the following APP ID
a47f325d0718ccd3e8aa1ec29c47d6d3a2cf18bca639b3fb1014b0362d163d06and click save. - Sign into your account or create one and click on Authorize button.
To get full access to the API we will require you send us some KYC/AML documents. Please contact [email protected] for further instructions.
Once the paperwork has been cleared it is time to generate an Application ID with its secret key and use these to generate a token and all subsequent token refreshes.
Go to https://www.volabit.com/oauth/applications and create an application with the default Redirect URL urn:ietf:wg:oauth:2.0:oob.
In the following view, click Authorize, follow instructions until you are provided with an authorization code.
if you like to do this programmatically you can redirect your users to https://www.volabit.com/oauth/authorize?client_id=APP_ID&redirect_uri=REDIRECT_URL&response_type=code.
This authorization code (AUTH_CODE) will be used to generate a access_token and a refresh_token with the following call:
curl -F grant_type=authorization_code \
-F client_id=APP_ID \
-F client_secret=APP_SECRET \
-F code=AUTH_CODE \
-F redirect_uri=urn:ietf:wg:oauth:2.0:oob \
-X POST https://www.volabit.com/oauth/tokenTokens can be used to make calls until they expire every 8 hours, afterwards you will use the refresh_token to generate a new token.
curl -F grant_type=refresh_token \
-F client_id=APP_ID \
-F client_secret=APP_SECRET \
-F refresh_token=REFRESH_TOKEN \
-X POST https://www.volabit.com/oauth/tokenYou can check your token info in
curl -H "Authorization: Bearer YOUR_TOKEN" \
https://www.volabit.com/oauth/token/infoTip: Check for an expired token in every call you make
Now that you can create and refresh tokens, lets move on to the interesting part.
For partner services
- Send money to a user in Volabit, the user might or might not be registered in volabit.com
- Request money from a Volabit user.
Required EndPoints:
api/v1/users [POST]api/v1/users/send [POST]api/v1/users/requests [POST]api/v1/users/requests/methods [POST]
For a seamless money sending and receiving experience Volabit requires you to register your customer as a Volabit user.
After you have created a Volabit user you can proceed to push and request payments from him/her.
In order to minimize exposure to the BTC value changes, Volabit allows some services to create instant/green addresses. Any money sent to one of these addresses will be immediately converted to fiat currency.
You will create a payment slip for the user and will provide a payment Bitcoin address. Whenever the user pays the slip (convenience store, bank deposit, etc) the fiat will be automatically converted to Bitcoins and immediately sent to the address that was provided when making the API call.
- If you haven’t already, create a Volabit user for your user, ideally you will use the email address he used for signing up with your service. This action is done with a
POST api/v1/userswith the following parameters: - [email] required: email of your user - [password] optional: if left blank Volabit will generate a random password for the user. An email notification will be sent to the user.
curl -H "Authorization: Bearer YOUR_TOKEN" \
-F user[email][email protected] \
-X POST https://www.volabit.com/api/v1/users- Get a quote in BTC for the amount of pesos to be sent to the user.
GET api/v1/spot-pricesallows for BTC/MXN and MXN/BTC conversions that include Volabit’s fees, hence the spot suffix. - [currency_from] required: Base currency you are converting from - [currency_to] required: Counter currency you are converting to. - [amount] required: Amount of the Base currency you want to convert to Counter currency. For sending 10,000 pesos to a Volabit user the params are: currency_from = MXN, currency_to = BTC, amount = 1000000
curl -F currency_from=BTC \
-F currency_to=MXN \
-F amount=100000000 \
https://www.volabit.com/api/v1/spot-prices- Generate a BTC address for the user.
POST api/v1/users/send. Any bitcoins sent to this address will be immediately converted to fiat with 0 confirmations. Note that this method allows for selecting who will pay the fee. If Sender is selected, the Volabit user will receive the full amount entered. If Receiver is selected, the fees will be deducted from the amount sent. Params: - [email_to] required: Email of the Volabit user that will be credited the money. - [currency_from] required: Only BTC for the moment - [currency_to] required: Only MXN for the moment - [amount] required: Amount in fiat (MXN) in cents the Volabit user will receive. - [fee_payer] required: Will the fee be deducted from the Volabit user? or will the BTC amount returned include the fee?
curl -H "Authorization: Bearer YOUR_TOKEN" \
-F [email protected] \
-F currency_from=BTC \
-F currency_to=MXN \
-F amount=500000 \
-F fee_payer=SENDER \
https://www.volabit.com/api/v1/users/send- If you haven’t already, create a Volabit user for your user, ideally you will use the email address he used for signing up with your service. This action is done with a
POST api/v1/userswith the following parameters: - [email] required: email of your user - [password] optional: if left blank Volabit will generate a random password for the user. An email notification will be sent to the user.
curl -H "Authorization: Bearer YOUR_TOKEN" \
-F user[email][email protected] \
-X POST https://www.volabit.com/api/v1/users- Create a payment slip for your user so you can collect a payment from him/her.
POST api/v1/users/requests- [email] required: Email of the Volabit user a payment is being requested from - [currency] required: The payment slip’s currency (only MXN for now) - [amount] required: The amount for which the payment slip will be created (in cents). - [type] required: For what convenience store will the slip be created for, you can get all accepted method throughGET api/v1/users/requests/methods. - [address] required: Bitcoin address where you want Volabit to send you the payment. Bitcoins will be sent the moment the payment is confirmed in Volabit’s platform.
curl -H "Authorization: Bearer YOUR_TOKEN" \
-F [email protected] \
-F currency=MXN \
-F amount=500000 \
-F type=oxxo_mx \
-F address=q15YTN2uxdJ7GMkvQ2prVJVfHcFw3t5YEwjq \
https://www.volabit.com/api/v1/users/requestsIf you have any questions please contact [email protected]