Authentication

Beam API authenticates your requests to ensure that they really come from you.

Authentication to the API is performed via HTTP Basic Auth. In the username and password fields, provide the following:

• Username - Provide your Beam Merchant ID
• Password - Provide your Beam API Key

Your Beam API Key can be self-managed through your account in Lighthouse under the Developers section.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail with the relevant error being returned to you.

API Key

API Key is used when you make a request from the server side. All of our APIs are authenticated in this manner.

CAUTION

Please DO NOT share your secret API keys in any publicly accessible places such as GitHub, GitLab, BitBucket, on your client-side code, and so on.

Here is an example of secret key usage to create a charge:

POST /api/v1/charges
Authorization: Basic <merchantId> <secretKey>

(create charge request body)
{
    ...
}