recurring

Manual Pull Endpoint

Manually request a pull cycle. Returns the (unchanged) authority record.

The actual chain-side pull submission is performed by the Sprint 1.5c cycle reaper (which this endpoint signals via setting next_cycle_due_at = now). For 1.5b this endpoint validates the request shape and updates next_cycle_due_at; the reaper picks up on its next sweep.

202 Accepted — the pull will execute on the reaper's next tick, not synchronously.

post/v1/recurring/pulls

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/pulls
  • Auth: none declared

Query parameters

tenant_idstring uuid nullable

Headers

x-tenant-idstring nullable
authorizationstring nullable

Request body

authority_idstring uuid required
amount_minorinteger required
notestring 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.