Introduction

The Beam API is organized around REST. Our API has predictable resource-oriented URLs, accepts and returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

To start accepting payments on Beam and use our API, you must be fully registered and verified as a valid merchant. Each request to the Beam API must be authenticated using your merchant's API key. Further details on how to authenticate your requests can be found in the Authentication guide.

Getting Started

There are two main ways to interact with the Beam API to accept payments:

Payment Links API: Create Beam-hosted payment links from API calls that can be shared with customers to accept payments. Suitable for merchants who want to quickly set up payment without their own interface.
Direct API Charges: Create charges directly via the API for various payment methods. Suitable for merchants who want to build or has a custom self-hosted payment interface to have more control over the payment flow.

Introduction

The Beam API is organized around REST. Our API has predictable resource-oriented URLs, accepts and returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Getting Started

There are two main ways to interact with the Beam API to accept payments:

Payment Links API: Create Beam-hosted payment links from API calls that can be shared with customers to accept payments. Suitable for merchants who want to quickly set up payment without their own interface.

Direct API Charges: Create charges directly via the API for various payment methods. Suitable for merchants who want to build or has a custom self-hosted payment interface to have more control over the payment flow.