Developers · reference index

Cross-border digital trade infrastructure, listed in the order you will meet it.

A REST API for orders, shipments, settlements and compliance; first-party SDKs for six languages; the tooling around both. Everything the platform exposes is on this page, with the address it answers on.

Reference 19 entries
01 Quickstart 01 entry
  1. 01

    Install, initialize, first order

    Add the SDK, initialize the client with an API key, and place your first cross-border order. Every endpoint follows the same conventions after that.

    quickstart.js node 18+
02 Orders 02 entries
  1. 02

    Create an order

    One POST returns the order, the tax line it resolved, and the settlement record it will reconcile against. Fraud screening runs on the way in, not after.

    /v1/orders 201 created
  2. 03

    Read an order back

    Status, settlement details, and every compliance check attached to the order, on a single read.

    /v1/orders/{id} 200 ok
03 Shipments 01 entry
  1. 04

    Hand an order to the routing layer

    Carrier selection, the label, and the tracking number come back on the same object — no second integration.

    /v1/shipments 201 created
04 Settlements 01 entry
  1. 05

    Settle and reconcile

    Send the settlement with an idempotency key and the split rules you configured take over. Replay the same request and you get the same record back, never a second payout.

    /v1/settlements 200 ok
05 Market & compliance 02 entries
  1. 06

    Quote a rate

    Live FX rates for the currencies you settle in, with the option to lock a rate before you commit.

    /v1/rates 200 ok
  2. 07

    Run compliance checks

    KYC/KYB verification, sanctions screening, and risk scoring behind one call, with the filing prepared for you.

    /v1/compliance 200 ok
06 Tooling 06 provisions
  1. 08

    Isolated Sandbox

    Build and break things freely in a full sandbox. Simulate transactions, fire webhooks, and cover edge cases well before go-live.

    sandbox
  2. 09

    Complete Documentation

    API references sit beside walkthroughs and tutorials. Every endpoint ships with request and response examples, plus code samples you can run.

    docs
  3. 10

    Webhook Notifications

    Events pushed the moment they happen for orders, settlements, disputes, and compliance status changes, backed by retry logic you can rely on.

    webhooks
  4. 11

    Security by Default

    API key authentication, IP whitelisting, request signing, and TLS 1.3 — infrastructure built to SOC 2 Type II control requirements.

    tls 1.3
  5. 12

    Performance at Scale

    Served from a distributed edge network with automatic failover and rate limiting already in place.

    edge
  6. 13

    Hands-On Support

    Priority email support, an active developer forum, and a dedicated Slack channel with direct access to the engineers who build the platform.

    support
07 Libraries 06 first-party SDKs
  1. 14

    Node.js

    npm install vintolra-sdk
  2. 15

    Python

    pip install vintolra-sdk
  3. 16

    Java

    // Maven: vintolra-sdk
  4. 17

    Go

    go get github.com/vintolra/sdk
  5. 18

    PHP

    composer require vintolra/sdk
  6. 19

    C#

    dotnet add package vintolra.SDK
Entry 01 · in full

The first call, start to finish.

The sandbox mirrors production — same routes, same response shapes, same screening. Copy the snippet, run it against a test key, and swap the environment when you are ready.

Sandbox
Full test environment, webhooks included
Idempotency
Replay a request, get the same record back
TLS 1.3
Encryption in transit, request signing
Webhooks
Signed events, retried until your endpoint answers
quickstart.js · request
// Install the SDK
npm install vintolra-sdk

// Initialize the client
const vintolra = require('vintolra-sdk');

const client = new vintolra.Client({
  apiKey: process.env.VIN_API_KEY,
  environment: 'sandbox' // or 'production'
});

// Create an order
const order = await client.orders.create({
  amount: 129.99,
  currency: 'USD',
  description: 'Premium e-commerce order #12345'
});

console.log(`Order created: ${order.id}`);

response · node 18+

{
  "id": "ord_9f41c7",
  "status": "screening",
  "amount": 129.99,
  "currency": "USD",
  "environment": "sandbox"
}

06 endpoints · 06 SDKs · sandbox open