Connect user
curl --request POST \
--url https://dev.bringin.xyz/api/v0/application/connect \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"email": "<string>",
"callback": "<string>",
"ref": "<string>",
"direction": "<string>",
"btcAddress": "<string>",
"iban": "<string>",
"bic": "<string>",
"beneficiaryName": "<string>",
"lnAddress": "<string>",
"currency": "<string>",
"network": "<string>"
}
'import requests
url = "https://dev.bringin.xyz/api/v0/application/connect"
payload = {
"email": "<string>",
"callback": "<string>",
"ref": "<string>",
"direction": "<string>",
"btcAddress": "<string>",
"iban": "<string>",
"bic": "<string>",
"beneficiaryName": "<string>",
"lnAddress": "<string>",
"currency": "<string>",
"network": "<string>"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
callback: '<string>',
ref: '<string>',
direction: '<string>',
btcAddress: '<string>',
iban: '<string>',
bic: '<string>',
beneficiaryName: '<string>',
lnAddress: '<string>',
currency: '<string>',
network: '<string>'
})
};
fetch('https://dev.bringin.xyz/api/v0/application/connect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.bringin.xyz/api/v0/application/connect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'callback' => '<string>',
'ref' => '<string>',
'direction' => '<string>',
'btcAddress' => '<string>',
'iban' => '<string>',
'bic' => '<string>',
'beneficiaryName' => '<string>',
'lnAddress' => '<string>',
'currency' => '<string>',
'network' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dev.bringin.xyz/api/v0/application/connect"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"callback\": \"<string>\",\n \"ref\": \"<string>\",\n \"direction\": \"<string>\",\n \"btcAddress\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"lnAddress\": \"<string>\",\n \"currency\": \"<string>\",\n \"network\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://dev.bringin.xyz/api/v0/application/connect")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"callback\": \"<string>\",\n \"ref\": \"<string>\",\n \"direction\": \"<string>\",\n \"btcAddress\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"lnAddress\": \"<string>\",\n \"currency\": \"<string>\",\n \"network\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.bringin.xyz/api/v0/application/connect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"callback\": \"<string>\",\n \"ref\": \"<string>\",\n \"direction\": \"<string>\",\n \"btcAddress\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"lnAddress\": \"<string>\",\n \"currency\": \"<string>\",\n \"network\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "connected",
"userRegistered": true,
"isUserConnected": true,
"apiKey": "NzY1YWQzZGYwNTE4NDQ4NzkxMTcxMTIxYzVmY2NlMDI="
}
{
"status": "pending",
"userRegistered": true,
"isUserConnected": false
}
{
"status": "onboarding",
"userRegistered": false,
"isUserConnected": false,
"signupURL": "https://app.bringin.xyz/signup?inviteId=..."
}
Onboarding
Connect user
POST
/
api
/
v0
/
application
/
connect
Connect user
curl --request POST \
--url https://dev.bringin.xyz/api/v0/application/connect \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"email": "<string>",
"callback": "<string>",
"ref": "<string>",
"direction": "<string>",
"btcAddress": "<string>",
"iban": "<string>",
"bic": "<string>",
"beneficiaryName": "<string>",
"lnAddress": "<string>",
"currency": "<string>",
"network": "<string>"
}
'import requests
url = "https://dev.bringin.xyz/api/v0/application/connect"
payload = {
"email": "<string>",
"callback": "<string>",
"ref": "<string>",
"direction": "<string>",
"btcAddress": "<string>",
"iban": "<string>",
"bic": "<string>",
"beneficiaryName": "<string>",
"lnAddress": "<string>",
"currency": "<string>",
"network": "<string>"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
callback: '<string>',
ref: '<string>',
direction: '<string>',
btcAddress: '<string>',
iban: '<string>',
bic: '<string>',
beneficiaryName: '<string>',
lnAddress: '<string>',
currency: '<string>',
network: '<string>'
})
};
fetch('https://dev.bringin.xyz/api/v0/application/connect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.bringin.xyz/api/v0/application/connect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'callback' => '<string>',
'ref' => '<string>',
'direction' => '<string>',
'btcAddress' => '<string>',
'iban' => '<string>',
'bic' => '<string>',
'beneficiaryName' => '<string>',
'lnAddress' => '<string>',
'currency' => '<string>',
'network' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dev.bringin.xyz/api/v0/application/connect"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"callback\": \"<string>\",\n \"ref\": \"<string>\",\n \"direction\": \"<string>\",\n \"btcAddress\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"lnAddress\": \"<string>\",\n \"currency\": \"<string>\",\n \"network\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://dev.bringin.xyz/api/v0/application/connect")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"callback\": \"<string>\",\n \"ref\": \"<string>\",\n \"direction\": \"<string>\",\n \"btcAddress\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"lnAddress\": \"<string>\",\n \"currency\": \"<string>\",\n \"network\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.bringin.xyz/api/v0/application/connect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"callback\": \"<string>\",\n \"ref\": \"<string>\",\n \"direction\": \"<string>\",\n \"btcAddress\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"lnAddress\": \"<string>\",\n \"currency\": \"<string>\",\n \"network\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "connected",
"userRegistered": true,
"isUserConnected": true,
"apiKey": "NzY1YWQzZGYwNTE4NDQ4NzkxMTcxMTIxYzVmY2NlMDI="
}
{
"status": "pending",
"userRegistered": true,
"isUserConnected": false
}
{
"status": "onboarding",
"userRegistered": false,
"isUserConnected": false,
"signupURL": "https://app.bringin.xyz/signup?inviteId=..."
}
Initiate a connection between a user and your application. This is how you get a per-user api-key.
Requires your master api-key. HMAC signing required if
callback is provided.
The user’s email address
Webhook URL where we send the api-key and status updates. Requires HMAC.
Your internal user ID. Returned in all webhooks so you can match them.
FIAT_TO_CRYPTO or CRYPTO_TO_FIAT. Pass this to create a connection in the same call.BTC address (26-90 chars). Required if
direction is FIAT_TO_CRYPTO.Valid IBAN. Required if
direction is CRYPTO_TO_FIAT.BIC/SWIFT code (8-11 chars).
Account holder name (2-100 chars).
Lightning address for LN sell connections.
BTC, ETH, USDC, or USDT. Default: BTC.Blockchain network. Default:
BTC.{
"status": "connected",
"userRegistered": true,
"isUserConnected": true,
"apiKey": "NzY1YWQzZGYwNTE4NDQ4NzkxMTcxMTIxYzVmY2NlMDI="
}
{
"status": "pending",
"userRegistered": true,
"isUserConnected": false
}
{
"status": "onboarding",
"userRegistered": false,
"isUserConnected": false,
"signupURL": "https://app.bringin.xyz/signup?inviteId=..."
}
⌘I