Skip to content

Corgi BankDocumentation

OpenAPI

Open a shortage or surplus claim against a sealed shipment

POST/cash-operations/claims

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

amountintegerRequired

directionstringRequired

Shortage, surplus

evidencestringRequired

evidence_sha256stringRequired

shipment_idstringRequired

Returns

200 OK

actorstringRequired

adjustment_idstringOptional

amountintegerRequired

carrier_idstringRequired

created_atstring · date-timeRequired

decisionobject or nullOptional

4 child attributes

actorstringRequired

approvebooleanRequired

evidencestringRequired

recorded_atstring · date-timeRequired

directionstringRequired

Shortage, surplus

evidencestringRequired

evidence_sha256stringRequired

idstringRequired

shipment_idstringRequired

Errors

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

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/cash-operations/claims' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 10000,
    "direction": "string",
    "evidence": "string",
    "evidence_sha256": "string",
    "shipment_id": "string"
  }'

Response200

{
  "actor": "string",
  "adjustment_id": "string",
  "amount": 10000,
  "carrier_id": "string",
  "created_at": "2026-09-17T14:30:00Z",
  "decision": {
    "actor": "string",
    "approve": false,
    "evidence": "string",
    "recorded_at": "2026-09-17T14:30:00Z"
  },
  "direction": "string",
  "evidence": "string",
  "evidence_sha256": "string",
  "id": "string",
  "shipment_id": "string"
}