Skip to main content
POST
mandate.setup

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: a step of this outcome has an external effect. A retry with the same key repeats no step that already acted.

Maximum string length: 255
Pramaan-Plan
string

The plan a person approved, from the estimate. Required when a step of the plan needs approval. A request that makes a different plan (another input, option, step, price, organisation or member), or a plan more than 15 minutes old, is refused with conflict.

Body

application/json
input
object
required

Customer consent with optional maxAmount, frequency, startDate and endDate. No current source honours mandate limits, so requests with limits are refused today.

options
object
basis
object

Optional: your stated lawful basis. Recorded on the run, not checked and never required.

Response

Run started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.