Skip to content
rigid.fi

List self-serve test-mode programme withdrawals

GET/v1/simulated-withdrawals

Requires an API client bearer token.

Lists self-serve test-mode withdrawals for one programme's float, cursor-paginated on id. When `currency` is passed, the response also carries that float’s current available balance (`float_available`) — null when omitted or when the float has never been minted into.

Parameters

Query parameters

NameRequiredDescription
program_idrequired
currencyoptional
limitoptional
starting_afteroptional

Example

curl https://api.rigid.fi/v1/simulated-withdrawals \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

A page of self-serve test-mode withdrawals for the named programme.

dataarray of objectrequired
+ show properties
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
has_morebooleanrequired
next_cursorstring (uuid) | nullrequired
float_availableone ofrequired
+ show properties

One of

Option 1

amountstringrequired
currency"EUR" | "GBP" | "USD"required

Option 2

{
  "type": "null"
}
400

Validation error

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
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring