Skip to content
rigid.fi

Mint self-serve test-mode funds onto a programme float

POST/v1/simulated-deposits

Requires an API client bearer token.

Self-serve TEST-MODE programme funding: mints test money onto the named programme's float via the ledger's issuance path, lazily creating the float on first use. Live-mode funding stays operator-only — this route is 403 in live mode regardless of caller role. Requires an Idempotency-Key header.

Parameters

Header parameters

NameRequiredDescription
Idempotency-Keyrequired

Client-chosen. An identical retry with the same key returns the stored response; reusing the key with a different payload returns 409.

Request body

program_idstring (uuid)required
amountobjectrequired
+ show properties
amountstringrequired
currency"EUR" | "GBP" | "USD"required
referencestring

Example

curl -X POST https://api.rigid.fi/v1/simulated-deposits \
  -H "Authorization: Bearer $RIGID_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "program_id": "uuid",
  "amount": {
    "amount": "string",
    "currency": "EUR"
  }
}'

Responses

200

Result of the deposit.

idstring (uuid)required
program_idstring (uuid)required
amountobjectrequired
+ show properties
amountstringrequired
currency"EUR" | "GBP" | "USD"required
actor_user_idstring | nullrequired
transfer_idstringrequired
float_account_idstringrequired
referencestring | nullrequired
created_atstringrequired
float_availableobjectrequired
+ show properties
amountstringrequired
currency"EUR" | "GBP" | "USD"required
replayedbooleanrequired
400

Validation error — including the tenant's test-mode issuance ceiling being exhausted (code `issuance_ceiling_reached`), or a missing/blank Idempotency-Key header

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Live mode, or caller is not a programme admin for this programme

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
409

Idempotency-Key reused with a different payload, or the ledger module is definitely not enabled

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
503

This programme's module configuration has not been received yet (code `config_cold`) — retry

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring