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

> ## Agent Instructions
> OwnPay is licensed under AGPL-3.0 and is completely free - no licensing fees.
> Production docs URL: https://ownpay.org/docs - append .md to any page URL for clean markdown.
> OwnPay requires PHP 8.3+, MySQL/MariaDB, and Redis.
> MCP server available at https://ownpay.org/docs/mcp for programmatic documentation queries.
> Use root-relative links (e.g. /quickstart) for internal navigation - do NOT include /docs prefix.
> Plugin development: consult /developer/plugin-types/ pages for correct interfaces and manifests.

# Create Customer

> Creates a new customer profile under the active brand. Checks for email uniqueness under this brand scope,
and encrypts PII values at rest for GDPR and OWASP compliance.




## OpenAPI

````yaml /api/merchant_api.yaml post /customers
openapi: 3.1.0
info:
  title: OwnPay Merchant API
  description: >
    The OwnPay Merchant API enables merchants to programmatically interface with
    their white-labeled payment gateway.

    It exposes endpoints to initiate payments (creating payment intents), query
    transaction statuses, issue full or partial refunds, manage customer
    profiles securely in compliance with GDPR and OWASP, generate and revoke API
    keys, and test/audit webhook delivery attempts.


    ### Authentication

    Authentication is performed via HTTP Bearer token in the `Authorization`
    header.

    ```http

    Authorization: Bearer your_api_key_here

    ```

    API keys carry specific privilege scopes (e.g., `read`, `write`, `admin`).

    Some administrative operations (like listing/generating API keys) require
    **both** `write` and `admin` scopes, as well as passing a valid platform
    super-administrator's email address in the `X-Super-Admin-Email` header for
    safety.
  version: 1.0.0
servers:
  - url: https://{brand_domain}/api/v1
    description: Sandbox or Production white-labeled brand gateway API server.
    variables:
      brand_domain:
        default: ownpay.org
        description: The custom domain configured for your white-labeled brand.
security:
  - BearerAuth: []
paths:
  /customers:
    post:
      summary: Create Customer
      description: >
        Creates a new customer profile under the active brand. Checks for email
        uniqueness under this brand scope,

        and encrypts PII values at rest for GDPR and OWASP compliance.
      operationId: createCustomer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerRequest'
      responses:
        '201':
          description: Customer record created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomerResponse'
        '409':
          description: A customer with this email already exists under this brand.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSingleErrorResponse'
        '422':
          description: Validation failure (e.g. missing name).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorsResponse'
        '500':
          description: Server error occurred during encryption or database operations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSingleErrorResponse'
components:
  schemas:
    CreateCustomerRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: Customer full display name.
          example: Alice Smith
        email:
          type: string
          format: email
          description: Customer email. Must be unique per brand.
          example: alice@example.com
        phone:
          type: string
          description: Customer phone.
          example: '+8801800000000'
    CreateCustomerResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            id:
              type: integer
              example: 58
            uuid:
              type: string
              format: uuid
              example: 83b9c9d2-b2f4-4df1-bc1e-b810d1c810d1
    ApiSingleErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Payment not found
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: PAYMENT_NOT_FOUND
              message:
                type: string
                example: Payment not found
              field:
                type: string
                nullable: true
                example: null
        request_id:
          type: string
          example: 8f5a2e9b0c7d4e5f
    ApiErrorsResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: amount must be a positive number
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: INVALID_AMOUNT
              message:
                type: string
                example: amount must be a positive number
              field:
                type: string
                example: amount
        request_id:
          type: string
          example: 8f5a2e9b0c7d4e5f
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Provide the Bearer API Key generated for your brand.

````

## Related topics

- [Laravel SDK - Fluent Payment Integration for PHP Apps](/docs/developer/integration/laravel.md)
- [Node.js SDK - TypeScript-First Payment Integration](/docs/developer/integration/nodejs.md)
- [Developer Quickstart - Build Your First Payment Integration](/docs/developer/quickstart.md)
- [Initiate Payment Intent](/docs/api-reference/initiate-payment-intent.md)
- [OwnPay API Overview - REST API for Multi-Brand Payments](/docs/api/overview.md)