List OT settlement instructions (obligations)

curl --request GET \
  --url http://localhost:9820/api/v1/siloc/settlement-instructions \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:9820/api/v1/siloc/settlement-instructions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:9820/api/v1/siloc/settlement-instructions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "hasMore": true,
  "items": [
    {
      "amountCanonical": "<string>",
      "amountRaw": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "cycleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "depositDeadlineAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "movementDate": "<string>",
      "numCtrlLdl": "<string>",
      "pendingBeyondTwoCycles": true,
      "periodCode": "<string>",
      "product": "<string>",
      "side": "DEBIT",
      "sourceNuOp": "<string>",
      "state": "RECEIVED",
      "traceabilityId": "<string>",
      "numCtrlStr": "<string>",
      "receivedAt": "2023-11-07T05:31:56Z",
      "terminalAt": "2023-11-07T05:31:56Z",
      "terminalSourceEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "terminalTimestampRaw": "<string>",
      "terminalTimestampSource": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

GET

api

siloc

settlement-instructions

List OT settlement instructions (obligations)

curl --request GET \
  --url http://localhost:9820/api/v1/siloc/settlement-instructions \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:9820/api/v1/siloc/settlement-instructions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:9820/api/v1/siloc/settlement-instructions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "hasMore": true,
  "items": [
    {
      "amountCanonical": "<string>",
      "amountRaw": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "cycleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "depositDeadlineAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "movementDate": "<string>",
      "numCtrlLdl": "<string>",
      "pendingBeyondTwoCycles": true,
      "periodCode": "<string>",
      "product": "<string>",
      "side": "DEBIT",
      "sourceNuOp": "<string>",
      "state": "RECEIVED",
      "traceabilityId": "<string>",
      "numCtrlStr": "<string>",
      "receivedAt": "2023-11-07T05:31:56Z",
      "terminalAt": "2023-11-07T05:31:56Z",
      "terminalSourceEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "terminalTimestampRaw": "<string>",
      "terminalTimestampSource": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

cycleId

string<uuid>

Restrict to one cycle.

state

enum<string>

Filter by lifecycle state.

Opciones disponibles:

RECEIVED,

FUNDING_REQUIRED,

CREDIT_EXPECTED,

SETTLED,

FAILED

cursor

string

Opaque pagination cursor.

limit

integer<int64>

predeterminado:50

Page size (default 50, max 200).

Rango requerido: 1 <= x <= 200

Respuesta

hasMore

boolean

requerido

Whether more pages follow.

items

object[] | null

requerido

The page of instructions (never null).

Show child attributes

nextCursor

string

Opaque cursor for the next page; empty when exhausted.

Integración

Conectividad

Participantes

Ciclos y liquidación

Alertas y auditoría

Programación

Manejo de errores

List OT settlement instructions (obligations)

Autorizaciones

Parámetros de consulta

Respuesta