Bolt Intent API

The Bolt Intent API lets you request a payment from a Beam Bolt device or the Beam Bolt app, and track the outcome. The following operations are available:

• Create Bolt Intent (POST /api/v1/bolt-intents): request a payment.
• Get Bolt Intent by ID (GET /api/v1/bolt-intents/{boltIntentId}): check the status and the payment result.
• Cancel Bolt Intent by ID (PATCH /api/v1/bolt-intents/{boltIntentId}/cancel): stop further payment attempts.

The fields you send when you create a Bolt Intent depend on the mode you use. See the Pairing Mode and Deep Link Mode guides for the flow and an example request in each mode.

mode.type accepts PAIRING or DEEP_LINK, and defaults to PAIRING when you leave mode out. STANDALONE is read-only: it appears on Bolt Intents that a device created by itself in Standalone Mode, and sending it when you create a Bolt Intent returns a 400.

Once created, a Bolt Intent cannot be modified. Cancel is the only mutation.

For request and response shapes, see the Bolt Intent API Specification. For supported payment methods, the status lifecycle, and how to read the payment result, see Bolt Intent. For the errors these endpoints return, see Error Handling.