Skip to content

Top up a card's funding account from the programme float

POST/v1/cards/{id}/topup

Requires an API client bearer token.

Moves money from the programme float onto the funding account of the named card. This moves money; it does not create it — see CardTopupRequest. Refused in live mode (403 live_mode_card_read_only) pending scheme certification. Requires an Idempotency-Key header.

Parameters

Path parameters

NameRequiredDescription
idrequired

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

amountobjectrequired
+ show properties
amountstringrequired
currency"EUR" | "GBP" | "USD"required
referencestring

Example

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

Responses

200

Result of the top-up.

card_idstringrequired
funding_account_idstringrequired
source_account_idstringrequired
transfer_idstringrequired
availableobjectrequired
+ show properties
amountstringrequired
currency"EUR" | "GBP" | "USD"required
replayedbooleanrequired
400

Validation error — including a missing/never-minted programme float, a currency mismatch between the top-up and the funding account, or a programme float that needs filling before it can fund this card

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden — the caller may not act on this programme, or (code `live_mode_card_read_only`) live mode refuses every top-up, a retry included, pending scheme certification

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Card not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
409

Idempotency-Key reused with a different payload, the card has no funding account (pre-#214), or the programme does not have the ledger module enabled (code `module_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