Deposit routes

4 operations under deposit-routes. Examples read $API and $KEY from your shell.

GET /v1/deposit-routes
POST /v1/deposit-routes
GET /v1/deposit-routes/{id}
POST /v1/deposit-routes/{id}/disable

`GET /v1/deposit-routes`

Parameters

status string optional in query, one of active, disabled
limit integer required in query
starting_after string optional in query

Responses

200 Default Response

object

data array required
Each item:
- id string required
- origin string required one of kyb_approval, api
- status string required one of active, disabled
- label string required (nullable)
- deposit_instructions object required
  - wire object required
    - rail string required one of wire
    - bank_name string required
    - account_number string required
    - reference string required
  - stellar object required (nullable)
    - rail string required one of stellar
    - muxed_address string required
- destination object required (nullable)
  - type string required one of stellar
  - counterparty_id string required
- created_at string required
- disabled_at string required (nullable)
has_more boolean required

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/deposit-routes?limit=1" \
  -H "authorization: Bearer $KEY"

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/deposit-routes", {
  params: { query: { limit: 1 } },
});

`POST /v1/deposit-routes`

Send an Idempotency-Key header on every POST so a retry never repeats the request.

Request body

application/json, required

object

destination object required
- type string required one of stellar
- counterparty_id string required
label string optional

Responses

201 Default Response

object

id string required
origin string required one of kyb_approval, api
status string required one of active, disabled
label string required (nullable)
deposit_instructions object required
- wire object required
  - rail string required one of wire
  - bank_name string required
  - account_number string required
  - reference string required
- stellar object required (nullable)
  - rail string required one of stellar
  - muxed_address string required
destination object required (nullable)
- type string required one of stellar
- counterparty_id string required
created_at string required
disabled_at string required (nullable)

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  -X POST \
  "$API/v1/deposit-routes" \
  -H "authorization: Bearer $KEY" \
  -H "idempotency-key: $(uuidgen)" \
  -H "content-type: application/json" \
  -d '{"destination":{"type":"stellar","counterparty_id":"<counterparty_id>"}}'

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key and an Idempotency-Key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.POST("/v1/deposit-routes", {
  body: {
    "destination": {
      "type": "stellar",
      "counterparty_id": "<counterparty_id>"
    }
  },
});

`GET /v1/deposit-routes/{id}`

Parameters

id string required in path

Responses

200 Default Response

object

id string required
origin string required one of kyb_approval, api
status string required one of active, disabled
label string required (nullable)
deposit_instructions object required
- wire object required
  - rail string required one of wire
  - bank_name string required
  - account_number string required
  - reference string required
- stellar object required (nullable)
  - rail string required one of stellar
  - muxed_address string required
destination object required (nullable)
- type string required one of stellar
- counterparty_id string required
created_at string required
disabled_at string required (nullable)

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/deposit-routes/$ID" \
  -H "authorization: Bearer $KEY"

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/deposit-routes/{id}", {
  params: { path: { id: "<id>" } },
});

`POST /v1/deposit-routes/{id}/disable`

Send an Idempotency-Key header on every POST so a retry never repeats the request.

Parameters

id string required in path

Request body

application/json, required

object

Responses

200 Default Response

object

id string required
origin string required one of kyb_approval, api
status string required one of active, disabled
label string required (nullable)
deposit_instructions object required
- wire object required
  - rail string required one of wire
  - bank_name string required
  - account_number string required
  - reference string required
- stellar object required (nullable)
  - rail string required one of stellar
  - muxed_address string required
destination object required (nullable)
- type string required one of stellar
- counterparty_id string required
created_at string required
disabled_at string required (nullable)

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  -X POST \
  "$API/v1/deposit-routes/$ID/disable" \
  -H "authorization: Bearer $KEY" \
  -H "idempotency-key: $(uuidgen)" \
  -H "content-type: application/json" \
  -d '{}'

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key and an Idempotency-Key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.POST("/v1/deposit-routes/{id}/disable", {
  params: { path: { id: "<id>" } },
  body: {},
});

Edit on GitHub