Unified checkout ​

The Unified Checkout flow is designed to require as little effort as possible while still maintaining as much flexibility as possible to match your needs.

By calling a single API endpoint you'll receive a URL that your users can follow in order to complete an order at BTC Direct. This allows you to quickly integrate the crypto onramping flow into your application.

Getting started ​

Get BTC Direct API credentials ​

In order to start using the Unified Checkout, you'll first need API credentials. Contact our sales team if you don't have credentials yet.

Authenticate as a partner ​

Before creating the checkout URL for your users, you need to log in as our client at the API. This allows us to determine your fee levels and other specific settings that you'd like for your users.

To do this, perform a call to the authentication endpoint. Note that the USERNAME and PASSWORD parts of the below code need to be replaced with your credentials.

More detailed information about the endpoint can be found here. This also describes how to refresh the token once it expires (after 1 hour).

// Production: 'https://api.btcdirect.eu/api/v2/buy/checkout'
// Sandbox: 'https://api-sandbox.btcdirect.eu/api/v2/buy/checkout'
$endpoint = 'https://api-sandbox.btcdirect.eu/api/v1/authenticate';

// Create the body values
$data = array(
    'username' => 'USERNAME',
    'password' => 'PASSWORD'
);

$options = array(
    'http' => array(
        'header'  => "Content-type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data),
    ),
);

$context  = stream_context_create($options);
$response = file_get_contents($endpoint, false, $context);
$result = json_decode($response, true);

$token = $result['token'];
$refreshToken = $result['refreshToken'];

// Production: 'https://api.btcdirect.eu/api/v1/authenticate'
// Sandbox: 'https://api-sandbox.btcdirect.eu/api/v1/authenticate'
const endpoint = 'https://api-sandbox.btcdirect.eu/api/v1/authenticate';

// Create the body values
const data = {
    'username': 'USERNAME',
    'password': 'PASSWORD'
}

// Call the authentication endpoint
const response = await fetch(endpoint, {
    method: 'POST',
    body: data
});

// Get the data from the response
const { token, refreshToken } = await response.json();

When the call is done correctly, the response will contain a token and refreshToken. The token is needed in the following call

{
    "token": "string",
    "refreshToken": "string"
}

Create the checkout URL ​

Once the partner authentication is done, a call can be done to the checkout endpoint. This call results in a URL that can be used to redirect the user towards, so they can perform their order. Note that the TOKEN part of the below code needs to be replaced with the token retrieved in the previous call.

More detailed information about the endpoint can be found here.

<?php
// Production: 'https://api.btcdirect.eu/api/v2/buy/checkout'
// Sandbox: 'https://api-sandbox.btcdirect.eu/api/v2/buy/checkout'
$endpoint = 'https://api-sandbox.btcdirect.eu/api/v2/buy/checkout';

$data = array(
    'baseCurrency' => 'BTC',
    'quoteCurrency' => 'EUR',
    'paymentMethod' => 'creditCard',
    'baseCurrencyAmount' => 131,
    'quoteCurrencyAmount' => 0.1,
    'returnUrl' => 'https://example.com/return',
    'callbackUrl' => 'https://example.com/callback',
    'partnerOrderIdentifier' => '123456789',
    'walletAddress' => '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
    'walletAddressTag' => '',
    'expireTime' => '500',
    'fee' => 0.1,
    'fixedAmount' => true,
    'fixedCurrency' => true,
    'fixedPaymentMethod' => true,
    'showWalletAddress' => true
);

$options = array(
    'http' => array(
        'header'  => "Content-type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data),
    ),
);

$context  = stream_context_create($options);
$response = file_get_contents($endpoint, false, $context);
$result = json_decode($response, true);

$checkoutUrl = $result['checkoutUrl'];
?>

// Production: 'https://api.btcdirect.eu/api/v2/buy/checkout'
// Sandbox: 'https://api-sandbox.btcdirect.eu/api/v2/buy/checkout'
const endpoint = 'https://api-sandbox.btcdirect.eu/api/v2/buy/checkout';

// Call the authentication endpoint
const response = await fetch(endpoint, {
    method: 'POST',
    headers: {
        Authorization: 'Bearer TOKEN'
    },
    body: {
        'baseCurrency': 'BTC',
        'quoteCurrency': 'EUR',
        'paymentMethod': 'creditCard',
        'baseCurrencyAmount': 131,
        'quoteCurrencyAmount': 0.1,
        'returnUrl': 'https://example.com/return',
        'callbackUrl': 'https://example.com/callback',
        'partnerOrderIdentifier': '123456789',
        'walletAddress': '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
        'walletAddressTag': '',
        'expireTime': '500',
        'fee': 0.1,
        'fixedAmount': true,
        'fixedCurrency': true,
        'fixedPaymentMethod': true,
        'showWalletAddress': true
    }
});

// Get the URL from the response
const { checkoutUrl } = await response.json();

When the call is done correctly, the response will contain your sent parameters appended with a checkoutUrl, signature, partner and apiKey. The checkoutUrl is the value that you'll need for this flow. When creating a custom integration, the other values can be used.

{
    "checkoutUrl": "string",
    "signature": "string",
    "partner": "string",
    "baseCurrency": "string",
    "quoteCurrency": "string",
    "paymentMethod": "string",
    "returnUrl": "string",
    "callbackUrl": "string",
    "baseCurrencyAmount": 0,
    "quoteCurrencyAmount": 0,
    "partnerOrderIdentifier": "string",
    "walletAddress": "string",
    "walletAddressTag": "string",
    "expireTime": 0,
    "fee": 0,
    "fixedAmount": true,
    "fixedCurrency": true,
    "fixedPaymentMethod": true,
    "showWalletAddress": true
}

Redirect the user to the checkout URL ​

When the checkout URL is retrieved in the previous call, you can redirect the user to that url. This will open the BTC Direct Unified Checkout functionality.

This shows the order form which is pre-filled with the information that was provided in the above /v2/buy/checkout call.