Skip to content

Corgi BankDocumentation

OpenAPI

Reserve complete check return funding before operator publication against reversal or reuse

POST/ledger/check-source-reservations

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

sourcesarray of objectsRequired

2 child attributes

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

keystringRequired

Returns

200 OK

keystringRequired

sourcesarray of objectsRequired

2 child attributes

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

keystringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/ledger/check-source-reservations' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "sources": [
      {
        "journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "key": "string"
      }
    ]
  }'

Response200

{
  "key": "string",
  "sources": [
    {
      "journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "key": "string"
    }
  ]
}