pub struct Mandate {Show 17 fields
pub approval_redirect: Option<PaymentRedirect>,
pub approved_at: Option<DateTime<Utc>>,
pub asset: Asset,
pub canceled_at: Option<DateTime<Utc>>,
pub created_at: DateTime<Utc>,
pub customer_display: Option<MandateCustomerDisplay>,
pub expires_at: Option<DateTime<Utc>>,
pub mandate_id: MandateId,
pub metadata: Option<Metadata>,
pub policy: MandatePolicy,
pub revocation_redirect: Option<PaymentRedirect>,
pub revocation_url: Option<Url>,
pub revoked_at: Option<DateTime<Utc>>,
pub source: Option<MandateSource>,
pub status: MandateStatus,
pub updated_at: DateTime<Utc>,
pub url: Option<Url>,
}Expand description
A durable, revocable standing authorization to debit a funding source without the customer present each time, within its policy caps. Payment sessions draw against it by referencing its mandateId.
`source` is set once an approval succeeds. `status` reflects the most recent action; the `approvedAt`, `canceledAt`, and `revokedAt` timestamps are the durable record of what has happened. Ending one mandate does not affect other mandates on the same `source`.JSON schema
{
"description": "A durable, revocable standing authorization to debit a funding `source` without the customer present each time, within its `policy` caps. Payment sessions draw against it by referencing its `mandateId`.\n\n`source` is set once an approval succeeds. `status` reflects the most recent action; the `approvedAt`, `canceledAt`, and `revokedAt` timestamps are the durable record of what has happened. Ending one mandate does not affect other mandates on the same `source`.",
"examples": [
{
"approvalRedirect": {
"failureUrl": "https://merchant.example.com/mandate/approval/failed",
"successUrl": "https://merchant.example.com/mandate/approval/success"
},
"approvedAt": "2025-06-15T12:05:00.000Z",
"asset": "usdc",
"createdAt": "2025-06-15T12:00:00.000Z",
"customerDisplay": {
"merchantName": "Acme Store"
},
"expiresAt": "2027-06-15T12:00:00.000Z",
"mandateId": "mandate_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
"metadata": {
"customer_id": "cust_12345"
},
"policy": {
"maxPerAuthorization": "50.00",
"maxPerPeriod": {
"amount": "500.00",
"period": "month"
}
},
"revocationRedirect": {
"failureUrl": "https://merchant.example.com/mandate/revocation/failed",
"successUrl": "https://merchant.example.com/mandate/revocation/success"
},
"revocationUrl": "https://payments.coinbase.com/mandates/mandate_82c879c1-84e1-44ed-a8c2-1ac239cf09ad/revoke",
"source": {
"address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
"asset": "usdc",
"network": "base"
},
"status": "approval_succeeded",
"updatedAt": "2025-06-15T12:05:00.000Z"
}
],
"type": "object",
"required": [
"asset",
"createdAt",
"mandateId",
"policy",
"status",
"updatedAt"
],
"properties": {
"approvalRedirect": {
"description": "Optional merchant URLs used by the hosted mandate approval flow. The approval page redirects to `successUrl` when approval succeeds, or `failureUrl` when it fails. When omitted, the approval page keeps the customer on the Coinbase-hosted experience.",
"examples": [
{
"failureUrl": "https://merchant.example.com/mandate/approval/failed",
"successUrl": "https://merchant.example.com/mandate/approval/success"
}
],
"allOf": [
{
"$ref": "#/components/schemas/PaymentRedirect"
}
]
},
"approvedAt": {
"description": "The UTC ISO 8601 timestamp at which an approval succeeded and the mandate became usable. Present only once the mandate has been approved; set once, on the successful approval, and unchanged by later transitions. Its presence is the durable signal that the mandate was approved, independent of `status`.",
"examples": [
"2026-08-21T13:55:00.000Z"
],
"type": "string",
"format": "date-time"
},
"asset": {
"description": "The unit of account the mandate's `policy` caps are denominated in (e.g., `500` means 500 of this asset). Fixed at creation. This is only the denomination for the limits; the funding `source` may hold a different asset (for example, limits in `usdc` against a `usdt` source). Each authorization's amount is converted into this asset at authorization time to evaluate the caps, so the caps are always enforced in a single denomination.",
"examples": [
"usdc"
],
"allOf": [
{
"$ref": "#/components/schemas/Asset"
}
]
},
"canceledAt": {
"description": "The UTC ISO 8601 timestamp at which the merchant canceled the mandate off-chain. Present only once the mandate has been canceled. Canceling does not touch the on-chain spending allowance; check `revokedAt` for that.",
"examples": [
"2026-08-21T14:02:00.000Z"
],
"type": "string",
"format": "date-time"
},
"createdAt": {
"description": "The UTC ISO 8601 timestamp at which the mandate was created.",
"examples": [
"2025-06-15T12:00:00.000Z"
],
"type": "string",
"format": "date-time"
},
"customerDisplay": {
"$ref": "#/components/schemas/MandateCustomerDisplay"
},
"expiresAt": {
"description": "The UTC ISO 8601 timestamp after which the mandate can no longer be authorized against. Authorization attempts after this time return `422`; `status` does not change. Omit for no expiry.",
"examples": [
"2027-06-15T12:00:00.000Z"
],
"type": "string",
"format": "date-time"
},
"mandateId": {
"description": "The unique identifier of the mandate.",
"examples": [
"mandate_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"
],
"allOf": [
{
"$ref": "#/components/schemas/MandateId"
}
]
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"policy": {
"description": "Debit caps. Always present. If you omitted `policy` at create, this is a Coinbase-configured monthly max.",
"examples": [
{
"maxPerAuthorization": "50.00",
"maxPerPeriod": {
"amount": "500.00",
"period": "month"
}
}
],
"allOf": [
{
"$ref": "#/components/schemas/MandatePolicy"
}
]
},
"revocationRedirect": {
"description": "Optional merchant URLs used by the hosted mandate revocation flow. The revocation page redirects to `successUrl` when revocation succeeds, or `failureUrl` when it fails. When omitted, the revocation page keeps the customer on the Coinbase-hosted experience.",
"examples": [
{
"failureUrl": "https://merchant.example.com/mandate/revocation/failed",
"successUrl": "https://merchant.example.com/mandate/revocation/success"
}
],
"allOf": [
{
"$ref": "#/components/schemas/PaymentRedirect"
}
]
},
"revocationUrl": {
"description": "Hosted page where the customer can remove their spending allowance for this mandate. Present once the mandate has a `source` (from `approval_succeeded` onward); absent before approval, when there is nothing to revoke.",
"readOnly": true,
"examples": [
"https://payments.coinbase.com/mandates/mandate_82c879c1-84e1-44ed-a8c2-1ac239cf09ad/revoke"
],
"allOf": [
{
"$ref": "#/components/schemas/Url"
}
]
},
"revokedAt": {
"description": "The UTC ISO 8601 timestamp at which the spending allowance was removed on-chain by a wallet revocation. Present only once that has happened. Its presence is the single signal that the allowance is gone, independent of `status` (for example, it can be set on a `canceled` mandate whose allowance was later cleaned up).",
"examples": [
"2026-08-21T14:12:00.000Z"
],
"type": "string",
"format": "date-time"
},
"source": {
"description": "The funding source the mandate draws against. Set when an approval succeeds. Not present before the mandate is `approval_succeeded`.",
"examples": [
{
"address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
"asset": "usdc",
"network": "base"
}
],
"allOf": [
{
"$ref": "#/components/schemas/MandateSource"
}
]
},
"status": {
"description": "The current status of the mandate.",
"examples": [
"approval_succeeded"
],
"allOf": [
{
"$ref": "#/components/schemas/MandateStatus"
}
]
},
"updatedAt": {
"description": "The UTC ISO 8601 timestamp at which the mandate was last updated.",
"examples": [
"2025-06-15T12:00:00.000Z"
],
"type": "string",
"format": "date-time"
},
"url": {
"description": "Hosted page where the customer approves this mandate. Present only before the mandate reaches `approval_succeeded`; complemented by `revocationUrl` afterward.",
"readOnly": true,
"examples": [
"https://payments.coinbase.com/mandates/mandate_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"
],
"allOf": [
{
"$ref": "#/components/schemas/Url"
}
]
}
}
}Fields§
§approval_redirect: Option<PaymentRedirect>Optional merchant URLs used by the hosted mandate approval flow. The approval page redirects to successUrl when approval succeeds, or failureUrl when it fails. When omitted, the approval page keeps the customer on the Coinbase-hosted experience.
approved_at: Option<DateTime<Utc>>The UTC ISO 8601 timestamp at which an approval succeeded and the mandate became usable. Present only once the mandate has been approved; set once, on the successful approval, and unchanged by later transitions. Its presence is the durable signal that the mandate was approved, independent of status.
asset: AssetThe unit of account the mandate’s policy caps are denominated in (e.g., 500 means 500 of this asset). Fixed at creation. This is only the denomination for the limits; the funding source may hold a different asset (for example, limits in usdc against a usdt source). Each authorization’s amount is converted into this asset at authorization time to evaluate the caps, so the caps are always enforced in a single denomination.
canceled_at: Option<DateTime<Utc>>The UTC ISO 8601 timestamp at which the merchant canceled the mandate off-chain. Present only once the mandate has been canceled. Canceling does not touch the on-chain spending allowance; check revokedAt for that.
created_at: DateTime<Utc>The UTC ISO 8601 timestamp at which the mandate was created.
customer_display: Option<MandateCustomerDisplay>§expires_at: Option<DateTime<Utc>>The UTC ISO 8601 timestamp after which the mandate can no longer be authorized against. Authorization attempts after this time return 422; status does not change. Omit for no expiry.
mandate_id: MandateIdThe unique identifier of the mandate.
metadata: Option<Metadata>§policy: MandatePolicyDebit caps. Always present. If you omitted policy at create, this is a Coinbase-configured monthly max.
revocation_redirect: Option<PaymentRedirect>Optional merchant URLs used by the hosted mandate revocation flow. The revocation page redirects to successUrl when revocation succeeds, or failureUrl when it fails. When omitted, the revocation page keeps the customer on the Coinbase-hosted experience.
revocation_url: Option<Url>Hosted page where the customer can remove their spending allowance for this mandate. Present once the mandate has a source (from approval_succeeded onward); absent before approval, when there is nothing to revoke.
revoked_at: Option<DateTime<Utc>>The UTC ISO 8601 timestamp at which the spending allowance was removed on-chain by a wallet revocation. Present only once that has happened. Its presence is the single signal that the allowance is gone, independent of status (for example, it can be set on a canceled mandate whose allowance was later cleaned up).
source: Option<MandateSource>The funding source the mandate draws against. Set when an approval succeeds. Not present before the mandate is approval_succeeded.
status: MandateStatusThe current status of the mandate.
updated_at: DateTime<Utc>The UTC ISO 8601 timestamp at which the mandate was last updated.
url: Option<Url>Hosted page where the customer approves this mandate. Present only before the mandate reaches approval_succeeded; complemented by revocationUrl afterward.