Skip to content
rigid.fi

Update programme configuration

PATCH/v1/programs/{id}

Requires an API client bearer token.

Updates mutable programme config. Requires an Idempotency-Key header. Restricted to programme admins of this programme, org admins, and org-wide API clients; programme members without the programme_admin role receive 403. Disabling a module with live dependencies (e.g. ledger with open balances) is rejected 409.

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

namestring
modulesobject

Non-toggleable keys are accepted but persisted false

+ show properties
ledgerboolean
managed_authorizationboolean

true = M2 (we decide); false = M2b delegated

kycboolean
fraudboolean
three_dsboolean
tokenizationboolean
disputesboolean
crypto_settlementboolean
delegated_auth_urlstring (uri) | null
refund_float_accountsobject

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

+ show properties
teststring
livestring

Example

curl -X PATCH https://api.rigid.fi/v1/programs/{id} \
  -H "Authorization: Bearer $RIGID_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "string",
  "modules": {
    "ledger": true,
    "managed_authorization": true,
    "kyc": true,
    "fraud": true,
    "three_ds": true,
    "tokenization": true
  },
  "delegated_auth_url": "uri",
  "refund_float_accounts": {
    "test": "string",
    "live": "string"
  }
}'

Responses

200

Updated 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
409

Module has dependencies, or Idempotency-Key reused with a different payload

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring