> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beem.africa/llms.txt
> Use this file to discover all available pages before exploring further.

# Whitelist website for iframe checkout

> Whitelist your website domain before embedding the Beem checkout library. Only HTTPS origins are accepted.



## OpenAPI

````yaml /openapi/payments-checkout.json post /whitelist/add-to-list
openapi: 3.0.3
info:
  title: Beem Payments Checkout API
  version: 1.0.0
  description: >-
    Bpay Checkout: request a hosted payment page, whitelist domains for iframe
    checkout, and receive payment status callbacks.
  contact:
    name: Beem
    url: https://beem.africa
    email: support@beem.africa
servers:
  - url: https://checkout.beem.africa/v1
    description: Bpay Checkout API
security: []
tags: []
paths:
  /whitelist/add-to-list:
    post:
      summary: Whitelist website for iframe checkout
      description: >-
        Whitelist your website domain before embedding the Beem checkout
        library. Only HTTPS origins are accepted.
      operationId: whitelistWebsiteForCheckout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - website
              properties:
                website:
                  type: string
                  format: uri
                  example: https://example.com
                  description: HTTPS URL of the website that will use checkout.
            examples:
              default:
                summary: Whitelist domain
                value:
                  website: https://example.com
      responses:
        '200':
          description: Domain whitelisted successfully
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - message
                properties:
                  status:
                    type: integer
                    example: 200
                  message:
                    type: string
                    example: successful
              examples:
                success:
                  summary: Domain whitelisted
                  value:
                    status: 200
                    message: successful
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
              examples:
                missingWebsite:
                  summary: Missing website field
                  value:
                    status: 400
                    message: '"website" is required'
        '401':
          description: Invalid authentication
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
              examples:
                invalidAuth:
                  summary: Invalid authentication
                  value:
                    code: 120
                    message: Invalid Authentication Parameters
        '403':
          description: Website must use HTTPS
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
              examples:
                insecureWebsite:
                  summary: Website must use HTTPS
                  value:
                    status: 403
                    message: Please make sure your using a secured connection i.e https
      security:
        - basicAuth: []
        - accessToken: []
      servers:
        - url: https://checkout.beem.africa/v1
          description: Bpay Checkout API
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Beem API credentials: API key as username, API secret as password.'
    accessToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Access token only. Send as Authorization: <token> — do not use a Bearer
        prefix.

````