ReferenceApi
Record onchain settlement observation
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
mandateId*string
authorizationId?string
executionId?string
intentId?string
chain*string
contractAddress*string
tokenAddress*string
tokenDecimals*integer
payeeAddress*string
txHash*string
blockNumber*integer
logIndex?integer
confirmations?integer
settlementStatus?string
failureReason?string
feeQuoteId?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/settlements" \ -H "Content-Type: application/json" \ -d '{ "mandateId": "string", "chain": "string", "contractAddress": "string", "tokenAddress": "string", "tokenDecimals": 0, "payeeAddress": "string", "txHash": "string", "blockNumber": 0 }'{ "mandateId": "string", "authorizationId": "string", "executionId": "string", "intentId": "string", "chain": "string", "contractAddress": "string", "tokenAddress": "string", "tokenDecimals": 0, "payeeAddress": "string", "txHash": "string", "blockNumber": 0, "logIndex": 0, "confirmations": 0, "settlementStatus": "pending", "failureReason": "string", "feeQuoteId": "string", "settlementId": "string", "enforcementPath": "onchain", "settlementMode": "openpermitContract", "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": {} }, "settlementReference": "string", "observedAt": "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 }, "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 }}