Skip to content

Corgi BankDocumentation

OpenAPI

Create a ledger account

POST/ledger/accounts

Open a ledger account (idempotent on address)

Headers

Idempotency-KeystringOptional

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

addressobjectRequired

Address of a ledger account.

5 child attributes

currency_codestringRequired

legal_entitystringRequired

namestringRequired

namespacestringRequired

ownerstringRequired

allow_negativebooleanRequired

gl_codestringRequired

protected_purposestringOptional

Returns

201 Created

The Ledger Account object.

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/accounts' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "address": {
      "currency_code": "USD",
      "legal_entity": "string",
      "name": "string",
      "namespace": "string",
      "owner": "string"
    },
    "allow_negative": false,
    "gl_code": "string"
  }'

Response201

{
  "address": {
    "currency_code": "USD",
    "legal_entity": "string",
    "name": "string",
    "namespace": "string",
    "owner": "string"
  },
  "allow_negative": false,
  "gl_code": "string",
  "id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "normal_balance": "string",
  "protected_purpose": "string",
  "status": "string",
  "type": "string"
}