Get an OT settlement cycle

curl --request GET \
  --url https://api.example.com/api/v1/siloc/cycles/{cycleId} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/cycles/{cycleId}"

	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('https://api.example.com/api/v1/siloc/cycles/{cycleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "movementDate": "<string>",
  "openedAt": "2023-11-07T05:31:56Z",
  "periodCode": "<string>",
  "product": "<string>",
  "status": "OPEN",
  "closedAt": "2023-11-07T05:31:56Z",
  "netPosition": {
    "amount": "<string>",
    "side": "DEBIT"
  },
  "reconciliation": {
    "cycleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "matched": true,
    "reason": "SOURCE_MISSING",
    "reconciledAt": "2023-11-07T05:31:56Z",
    "clearingAmount": "<string>",
    "clearingSide": "DEBIT",
    "mismatchDetail": "<string>",
    "resultNoticeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settledAmount": "<string>"
  },
  "settledAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

api

siloc

cycles

{cycleId}

Get an OT settlement cycle

curl --request GET \
  --url https://api.example.com/api/v1/siloc/cycles/{cycleId} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/cycles/{cycleId}"

	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('https://api.example.com/api/v1/siloc/cycles/{cycleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "movementDate": "<string>",
  "openedAt": "2023-11-07T05:31:56Z",
  "periodCode": "<string>",
  "product": "<string>",
  "status": "OPEN",
  "closedAt": "2023-11-07T05:31:56Z",
  "netPosition": {
    "amount": "<string>",
    "side": "DEBIT"
  },
  "reconciliation": {
    "cycleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "matched": true,
    "reason": "SOURCE_MISSING",
    "reconciledAt": "2023-11-07T05:31:56Z",
    "clearingAmount": "<string>",
    "clearingSide": "DEBIT",
    "mismatchDetail": "<string>",
    "resultNoticeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settledAmount": "<string>"
  },
  "settledAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "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",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

cycleId

string<uuid>

required

Cycle id.

Response

createdAt

string<date-time>

required

Row creation instant (list cursor key).

string<uuid>

required

Cycle id.

movementDate

string

required

Business (reference) date, YYYY-MM-DD.

openedAt

string<date-time>

required

PAG0102 open instant (DtHrAbert).

periodCode

string

required

Operating-period token (e.g. 01, 02).

product

string

required

Rail product; always OT.

status

enum<string>

required

Cycle lifecycle.

Available options:

OPEN,

SETTLING,

RECALCULATING,

CLOSED

closedAt

string<date-time>

Deposit-period close instant (PAG0103.DtHrFcht); present while the cycle still awaits its money too.

netPosition

object

The FI's net position, from the single correlated instruction; omitted for a pre-intake OPEN cycle.

Show child attributes

reconciliation

object

The cycle's reconciliation against the GEN0015 result; omitted until one exists.

Show child attributes

settledAt

string<date-time>

Settlement instant; omitted until settled.

Integration

Connectivity

Homologation

Participants

Cycles and settlement

Transfers

Collateral

Card route

Entries and statements

Advices and notices

Alerts and audit

Schedule

Error handling

Get an OT settlement cycle

Authorizations

Path Parameters

Response