recurring

Confirm Authority Endpoint

Mark an authority active after on-chain landing.

The tenant calls this once they (or the AlgoVoi widget) has confirmed the customer's signed transaction group landed on-chain. on_chain_address carries the chain-specific identifier (e.g. app:<application_id>).

post/v1/recurring/authorities/{authority_id}/confirm

Request

  • Base URL: https://api.algovoi.co.uk (the document declares no server; this is the origin it was published from)
  • URL: https://api.algovoi.co.uk/v1/recurring/authorities/{authority_id}/confirm
  • Auth: none declared

Path parameters

authority_idstring uuid required

Query parameters

tenant_idstring uuid nullable

Headers

x-tenant-idstring nullable
authorizationstring nullable

Request body

on_chain_addressstring required
first_cycle_due_atstring date-time nullable

Response

Successful Response

idstring uuid required
tenant_idstring uuid required
subscription_idstring uuid required
chainstring required
customer_wallet_addressstring required
on_chain_addressstring nullable required
cap_amount_minorinteger required
cap_period_secondsinteger required
per_cycle_amount_minorinteger required
assetstring required
facilitator_addressstring required
merchant_payout_addressstring required
status'pending' | 'active' | 'depleted' | 'revoked' | 'paused' | 'errored' required
cap_remaining_minorinteger required
cycles_pulledinteger required
cycles_failedinteger required
next_cycle_due_atstring date-time nullable required
last_pull_atstring date-time nullable required
last_errorstring nullable required
created_atstring date-time required
activated_atstring date-time nullable required
revoked_atstring date-time nullable required
expires_atstring date-time required
metadataobject required

Changes

No recorded changes to this operation across all 1 revision of this API.