API Reference

Bridges

Configurations that connect the ledger to external financial systems — a bridge declares its capabilities (`debits`, `credits`, `anchors`, `events`) and the URL of your bridge server.

List bridges

GET
/bridges

Authorization

BearerAuth LedgerHeader
AuthorizationBearer <token>

Access token obtained from POST /oauth/token

In: header

x-ledger<token>

Handle of the target ledger (e.g. demo-co)

In: header

Query Parameters

limit?integer

Maximum records to return

Default25
Rangevalue <= 100
offset?integer

Records to skip

Default0

Response Body

application/json

curl -X GET "https://demo-co.ldg-stg.one/api/v2/bridges"
{
  "data": [
    {
      "handle": "bancorojo.com.co/minka",
      "url": "https://bridge.bancorojo.com.co/v2",
      "traits": [
        "debits",
        "credits"
      ],
      "auth": {
        "schema": "header",
        "headers": {
          "property1": "string",
          "property2": "string"
        },
        "clientId": "string",
        "clientSecret": "string",
        "tokenUrl": "http://example.com",
        "public": "string",
        "secret": "string"
      },
      "custom": {}
    }
  ],
  "meta": {
    "total": 4,
    "limit": 25,
    "offset": 0
  }
}

Register bridge

POST
/bridges

Authorization

BearerAuth LedgerHeader
AuthorizationBearer <token>

Access token obtained from POST /oauth/token

In: header

x-ledger<token>

Handle of the target ledger (e.g. demo-co)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://demo-co.ldg-stg.one/api/v2/bridges" \  -H "Content-Type: application/json" \  -d '{    "data": {      "handle": "bancorojo.com.co/minka",      "url": "https://bridge.bancorojo.com.co/v2",      "traits": [        "debits",        "credits"      ],      "auth": {        "schema": "oauth2",        "clientId": "minka-hub-client",        "clientSecret": "s3cr3t",        "tokenUrl": "https://auth.bancorojo.com.co/oauth/token"      }    }  }'
{
  "data": {
    "handle": "bancorojo.com.co/minka",
    "url": "https://bridge.bancorojo.com.co/v2",
    "traits": [
      "debits",
      "credits"
    ],
    "auth": {
      "schema": "header",
      "headers": {
        "property1": "string",
        "property2": "string"
      },
      "clientId": "string",
      "clientSecret": "string",
      "tokenUrl": "http://example.com",
      "public": "string",
      "secret": "string"
    },
    "custom": {}
  }
}

Get bridge

GET
/bridges/{handle}

Authorization

BearerAuth LedgerHeader
AuthorizationBearer <token>

Access token obtained from POST /oauth/token

In: header

x-ledger<token>

Handle of the target ledger (e.g. demo-co)

In: header

Path Parameters

handle*string

Record handle

Response Body

application/json

application/json

curl -X GET "https://demo-co.ldg-stg.one/api/v2/bridges/pay-20260608-001"
{
  "data": {
    "handle": "bancorojo.com.co/minka",
    "url": "https://bridge.bancorojo.com.co/v2",
    "traits": [
      "debits",
      "credits"
    ],
    "auth": {
      "schema": "header",
      "headers": {
        "property1": "string",
        "property2": "string"
      },
      "clientId": "string",
      "clientSecret": "string",
      "tokenUrl": "http://example.com",
      "public": "string",
      "secret": "string"
    },
    "custom": {}
  }
}
{
  "error": {
    "code": "not-found",
    "message": "Wallet not found"
  }
}

Activate bridge

POST
/bridges/{handle}/activate

Authorization

BearerAuth LedgerHeader
AuthorizationBearer <token>

Access token obtained from POST /oauth/token

In: header

x-ledger<token>

Handle of the target ledger (e.g. demo-co)

In: header

Path Parameters

handle*string

Record handle

Response Body

application/json

curl -X POST "https://demo-co.ldg-stg.one/api/v2/bridges/pay-20260608-001/activate"
Empty
{
  "error": {
    "code": "not-found",
    "message": "Wallet not found"
  }
}

On this page

No Headings