ReferenceApi
Create onchain mandate registration transaction plan
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
chain*string
contractAddress?string
tokenAddress?string
tokenDecimals?integer
tokenName?string
tokenVersion?string
payeeAddress*string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/onchain/mandates/string/registration-plan" \ -H "Content-Type: application/json" \ -d '{ "chain": "string", "payeeAddress": "string" }'{ "planId": "string", "enforcementPath": "onchain", "settlementMode": "offchainAuthorized", "mandateId": "string", "authorizationId": "string", "intentId": "string", "chain": "string", "contractAddress": "string", "action": "registerMandate", "calls": [ { "contractAddress": "string", "functionName": "string", "args": {}, "value": "0", "data": "string" } ], "feeQuote": { "feeQuoteId": "string", "feeScheduleId": "string", "buyerOrganizationId": "string", "sellerOrganizationId": "string", "settlementMode": "offchainAuthorized", "enforcementPath": "offchain", "paymentProtocol": "x402", "paymentChallengeType": "x402", "chain": "string", "asset": "string", "grossAmount": "string", "sellerNetAmount": "string", "openPermitFeeAmount": "string", "providerFeeAmount": "0", "networkFeeAmount": "0", "feePayer": "buyer", "feeRecipient": "string", "feeScheduleHash": "string", "expiresAt": "string", "createdAt": "string", "metadata": {} }, "expiresAt": "string", "metadata": {}}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }, "errors": [ { "detail": "string", "pointer": "string" } ]}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "category": "buyer_action_required", "actor": "buyer", "retryable": true, "payment": { "chain": "string", "asset": "string", "tokenAddress": "string", "tokenDecimals": 0, "amount": "string", "amountAtomic": "string", "requiredAmount": "string", "requiredAmountAtomic": "string", "balance": "string", "balanceAtomic": "string", "payer": "string", "payTo": "string" }, "nextActions": [ { "type": "fund_wallet", "label": "string", "description": "string", "href": "http://example.com", "address": "string", "chain": "string", "asset": "string", "amount": "string", "metadata": { "property1": null, "property2": null } } ], "debug": { "property1": null, "property2": null }}