RecordConsentRequest

consent_typestringrequired

The category of consent to record a decision for, such as auto_top_up.

Possible values: [auto_top_up]

Example: auto_top_up

actionstringrequired

The consent decision to record, either granted or revoked.

Possible values: [granted, revoked]

Example: granted

consent_methodstring

How the consent decision is being captured, such as api.

Possible values: [web_checkbox, api, admin_override]

Default: web_checkbox

Example: web_checkbox

consent_versionstring

Version identifier. Defaults to the current version for the consent type

metadata object

Consent-type-specific metadata. For auto_top_up, this is required and must include threshold_amount, topup_amount, and payment_method_ref.

object

RecordConsentRequest

{
  "consent_type": "auto_top_up",
  "action": "granted",
  "consent_method": "web_checkbox",
  "consent_version": "string",
  "metadata": {}
}