Intents

https://api.payload.com/intents

Nested Objects

https://api.payload.com/intents/{id}/client_token

Example

{
  "id": "int_1YOTfqL6CPeu7opBdhDpOZyrT",
  "object": "intent",
  "attrs": {},
  "client_token_id": "1DbYl0MpNgKZ9r6ETILOxll6h",
  "created_at": "2024-08-21 13:35:03",
  "modified_at": "2024-08-21 13:35:03",
  "status": "pending",
  "type": "checkout_plugin",
  "checkout_page": {
    "amount": 561.31,
    "bank_account_payments": true,
    "billing_address": false,
    "card_payments": false,
    "customer_id": "13ZtuaH6ZaLN51w3GYUhnsJvd",
    "description": "string",
    "enable_mobile_wallets": false,
    "invoice_id": "1WDn5hHZFxNCK7TLmGGBFL086",
    "payment": {},
    "processing_id": "11x9teZ6bcPLc0noTcJrcHKoG",
    "show_disclosure": false,
    "status": "authorized",
    "redirects": {
      "completed_url": "string",
      "return_url": "string"
    }
  },
  "checkout_plugin": {
    "amount": 999.71,
    "amount_editable": false,
    "attrs": {},
    "auto_billing_toggle": true,
    "bank_account_payments": false,
    "billing_address": true,
    "card_payments": true,
    "conv_fee": true,
    "customer_id": "Z0EU9rOmrB9BG4q41Qxko7Wk",
    "description": "string",
    "invoice_id": "1Q3zudRgyQMv1zSCi2BZH5vsx",
    "keep_active_toggle": false,
    "order_number": "string",
    "payment_method_defaults": {},
    "payment_method_preview": true,
    "processing_id": "1nVs9pk8K4TOj92PycPlnSWC0",
    "processing_method_id": "wOW0SpJhXqqni1hSJfs9gbvG",
    "processing_settings_id": "yBBlsxlr5kM6pH20t5W4MprY",
    "status": "authorized"
  },
  "payment_form": {
    "payment": {}
  },
  "payment_method_form": {
    "payment_method": {}
  }
}

Attributes	Description
`id` string readonly	Object ID
`object` string readonly	Value: intent
`attrs` json	Custom object attributes
`client_token_id` id readonly: update	ID of client token
`created_at` datetime readonly	None
`modified_at` datetime readonly	None
`status` string readonly	Values: pending finished
`type` string readonly: update	Values: checkout_plugin checkout_page payment_form payment_method_form processing_account_plugin oauth_client_token

checkout_page:
`amount` number	Amount of payment
`bank_account_payments` bool	Enable bank account payments
`billing_address` bool	Require full billing address
`card_payments` bool	Enable card payments
`customer_id` id	ID of the associated Customer object
`description` string	Description of payment
`enable_mobile_wallets` bool	Enable Google/Apple Pay
`invoice_id` id	ID of the associated Invoice object
`payment` json	Preset values for the resulting Payment object
`processing_id` id	ID of the associated Processing Account object
`show_disclosure` bool	Show disclosure
`status` string	Values: authorized processed

redirects:
`completed_url` string required	URL to redirect to once the payment is completed
`return_url` string required	URL to redirect to if the return button is clicked

checkout_plugin:
`amount` number	Amount of payment
`amount_editable` bool	Allow the amount field to be editable
`attrs` json	Transaction custom attributes JSON object.
`auto_billing_toggle` bool	Adds an option to allow the customer to set the payment method as the billing default.
`bank_account_payments` bool	Enable bank account payments
`billing_address` bool	Require full billing address
`card_payments` bool	Enable card payments
`conv_fee` bool	Specify whether the fee should be charged as a convenience.
`customer_id` id	ID of the associated Customer object
`description` string	Description of payment
`invoice_id` id	ID of the associated Invoice object
`keep_active_toggle` bool	Adds an option to allow the customer to store the payment method for future use.
`order_number` string	Provice a custom order number for the payment.
`payment_method_defaults` json	Preset values for the resulting Payment Method object
`payment_method_preview` bool	Set to true to show a graphical preview of the payment method above the checkout form.
`processing_id` id	ID of the associated Processing Account object
`processing_method_id` id	ID of the associated Processing Method object
`processing_settings_id` id	ID of the associated Processing Settings object
`status` string	Values: authorized processed

payment_form:
`payment` json	Preset values for the resulting Payment object

payment_method_form:
`payment_method` json	Preset values for the resulting Payment Method object