OpenPermit Docs
ReferenceApi

Authorize payment against mandate policy

POST
/api/v1/payments/authorize

Authorization

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

mandateId*string
intent*

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/payments/authorize" \  -H "Content-Type: application/json" \  -d '{    "mandateId": "string",    "intent": {      "intentId": "string",      "enforcementPath": "offchain",      "paymentChallengeType": "x402",      "seller": {        "sellerId": "string",        "name": "string",        "domain": "string"      },      "resource": {        "resourceId": "string",        "sellerId": "string",        "method": "GET",        "pathTemplate": "string",        "pricing": {          "type": "fixed",          "amount": "string",          "asset": "string"        },        "acceptedPaymentChallengeTypes": [          "x402"        ]      },      "amount": "string",      "asset": "string",      "expiresAt": "string",      "nonce": "string",      "idempotencyKey": "string",      "createdAt": "string"    }  }'
{  "authorizationId": "string",  "policyDecision": {    "policyDecisionId": "string",    "mandateId": "string",    "intentId": "string",    "outcome": "allow",    "reasons": [],    "denialCode": "string",    "reservationId": "string",    "createdAt": "string"  },  "expiresAt": "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  }}