Skip to content
rigid.fi

Retrieve a programme

GET/v1/programs/{id}

Requires an API client bearer token.

Fetch a programme by id (tenant-scoped).

Parameters

Path parameters

NameRequiredDescription
idrequired

Example

curl https://api.rigid.fi/v1/programs/{id} \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

The programme.

idstringrequired
namestringrequired
home_regionstringrequired
modulesobjectrequired
+ show properties
ledgerbooleanrequired
managed_authorizationbooleanrequired
kycbooleanrequired
fraudbooleanrequired
three_dsbooleanrequired
tokenizationbooleanrequired
disputesbooleanrequired
crypto_settlementbooleanrequired
delegated_auth_urlstring | nullrequired
status"draft" | "in_review" | "live" | "suspended"required
created_atstringrequired
refund_float_accountsobject

Per-mode platform settlement account a refund credit is drawn from. Absent ⇒ refunds decline.

+ show properties
teststring
livestring
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Programme not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring