Issue a mandate

Authorization

x-api-key<token>

Your API key. Issued and revoked from the TrustPixel dashboard; the gateway resolves it to an owning organization on every request.

In: header

Header Parameters

x-request-id?string

Correlation id echoed to the upstream service and returned on the response. Generated as req_<uuid> when omitted.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

user_id*User Id

mode?Mode

Default"closed"

Value in

"closed"
"open"

payee?

payment_amount*

payment_instrument*

agent_id?string|null

expires_in_seconds?Expires In Seconds

Range0 < value <= 7776000

Default3600

constraints?array<>

Default[]

evidence?

Response Body

`application/json`

curl -X POST "https://example.com/v1/mandate" \  -H "Content-Type: application/json" \  -d '{    "user_id": "string",    "payment_amount": {      "currency": "string",      "amount": 1    },    "payment_instrument": {      "id": "string",      "type": "string"    }  }'

null

Authorization

Header Parameters

Request Body

Response Body

201application/json

401application/json

422application/json

502application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`