OpenPermit Docs
ReferenceApi

Approve a checkout in the trusted OpenPermit surface and mint its continuation token

POST
/api/v1/agent/commerce/checkouts/{checkoutIntentId}/approve

Authorization

Path Parameters

checkoutIntentId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

mandateId?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/agent/commerce/checkouts/string/approve" \  -H "Content-Type: application/json" \  -d '{}'
{  "intent": {    "checkoutIntentId": "string",    "ownerSubjectId": "string",    "ownerOrganizationId": "string",    "sellerId": "string",    "storefrontUrl": "http://example.com",    "mandateId": "string",    "detectedMandateId": "string",    "mandateStatus": "active_match",    "canonicalBasket": {      "sellerId": "string",      "asset": "string",      "lines": [        {          "productId": "string",          "variantId": "string",          "name": "string",          "color": "string",          "size": "string",          "quantity": 1,          "unitAmount": "string",          "displayUnitAmount": "string",          "asset": "string"        }      ]    },    "basketHash": "string",    "amount": "string",    "displayAmount": "string",    "asset": "string",    "chain": "string",    "payTo": "string",    "tokenAddress": "string",    "tokenDecimals": 0,    "quoteId": "string",    "status": "previewed",    "environment": "sandbox",    "effects": {      "movesFunds": true,      "createsFulfillmentOrder": true,      "settlement": "none"    },    "createdAt": "string",    "expiresAt": "string"  },  "approval": {    "approvalId": "string",    "checkoutIntentId": "string",    "status": "pending",    "approvedAt": "string",    "approvedBySubjectId": "string",    "preselectedMandateId": "string",    "mandateId": "string",    "authorizationId": "string",    "approvalSurface": "openpermit_hosted_confirmation",    "approvedBasketHash": "string",    "approvedAmount": "string",    "approvedAsset": "string",    "continuationTokenId": "string",    "continuationTokenStatus": "active",    "expiresAt": "string",    "createdAt": "string"  },  "mandates": []}
{  "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  }}