Skip to main content
POST
/
api
/
v0
/
bringin-link
Create connection
curl --request POST \
  --url https://dev.bringin.xyz/api/v0/bringin-link \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "subtype": "<string>",
  "destinationAddress": "<string>",
  "destinationCurrency": "<string>",
  "network": "<string>",
  "sourceCurrency": "<string>",
  "beneficiary": {},
  "beneficiaryId": "<string>",
  "lnAddress": "<string>",
  "whitelistedAddressId": "<string>"
}
'
{
  "bringinLink": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My BTC savings",
    "type": "FIAT_TO_CRYPTO",
    "subtype": "ONCHAIN",
    "status": "INITIATING",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
Create a new connection (BringinLink). The standing order is created asynchronously — poll GET /bringin-link/{id} to track progress. Requires a per-user api-key.
​
name
string
required
User-facing label (2-50 chars). Must be unique per user across active connections.
​
type
string
required
FIAT_TO_CRYPTO or CRYPTO_TO_FIAT
​
subtype
string
required
ONCHAIN or LN
​
destinationAddress
string
BTC address (26-90 chars). Required for FIAT_TO_CRYPTO.
​
destinationCurrency
string
default:"BTC"
BTC, ETH, USDC, or USDT
​
network
string
Blockchain network (e.g., BTC, ETH, POLYGON). Required for FIAT_TO_CRYPTO.
​
sourceCurrency
string
default:"BTC"
Source currency for CRYPTO_TO_FIAT + ONCHAIN.
​
beneficiary
object
Bank account details. Required for CRYPTO_TO_FIAT.
  • iban (string, required) — Valid IBAN
  • bic (string, required) — BIC/SWIFT code
  • name (string, required) — Account holder name (2-100 chars)
​
beneficiaryId
string
Use an existing beneficiary instead of raw beneficiary details.
​
lnAddress
string
Lightning address (e.g., alice@bringin.xyz). Required for LN subtype.
​
whitelistedAddressId
string
Use an existing whitelisted address instead of destinationAddress.
{
  "bringinLink": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My BTC savings",
    "type": "FIAT_TO_CRYPTO",
    "subtype": "ONCHAIN",
    "status": "INITIATING",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}