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

# Add whitelisted address



## OpenAPI

````yaml openapi.json POST /v1/whitelist-address
openapi: 3.0.3
info:
  title: Payluk ThirdParty API
  version: 1.0.0
  description: >-
    Merchant / Business API for the Payluk escrow and payments platform.


    All routes are mounted under `/v1` and authenticated with a secret key.
    Every response uses the standard envelope `{ status, message, data }`.
  contact:
    name: Payluk Developer Support
    email: support@payluk.ng
    url: https://payluk.ng
servers:
  - url: https://staging.api.payluk.ng
    description: 'Staging: use sk_test_ keys here for safe testing'
  - url: https://api.payluk.ng
    description: 'Production: use sk_live_ keys'
security:
  - bearerAuth: []
tags:
  - name: Escrow
    description: Create and manage standard escrow payment links.
  - name: Milestone Escrow
    description: Escrows that release funds in parts as milestones are confirmed.
  - name: Vault Escrow
    description: >-
      Merchant-only pooled-stake escrows: customers stake from their wallets and
      the merchant declares the winner.
  - name: Categories
    description: Organise escrows into merchant-defined categories.
  - name: Merchant Customers
    description: Manage the buyers and sellers that transact under your merchant account.
  - name: Disputes
    description: Confirm deliveries, raise disputes and resolve them.
  - name: Payments
    description: Fund wallets and escrows, verify references and manage payout details.
  - name: Debit Cards
    description: List and remove customers' saved debit cards.
  - name: Crypto Whitelist
    description: Manage whitelisted crypto withdrawal addresses.
  - name: Misc
    description: Supporting reference data.
paths:
  /v1/whitelist-address:
    post:
      tags:
        - Crypto Whitelist
      summary: Add whitelisted address
      operationId: addWhitelistAddress
      parameters:
        - $ref: '#/components/parameters/CustomerIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - walletAddress
                - network
              properties:
                walletAddress:
                  type: string
                  description: >-
                    Recipient wallet address: `0x` followed by 40 hexadecimal
                    characters.
                  example: '0x0915ea16f52b11444695d283e6c0f5936d1e0d56'
                network:
                  type: string
                  enum:
                    - BSC
                  example: BSC
                label:
                  type: string
                  maxLength: 50
                  example: My Wallet address
                otp:
                  type: string
                  description: Optional one-time password, if required.
      responses:
        '201':
          description: Address whitelisted.
          content:
            application/json:
              example:
                status: 201
                message: Wallet address whitelisted successfully
                data:
                  id: 69badc24766aab029e6dc789
                  walletAddress: '0x0915ea16f52b11444695d283e6c0f5936d1e0d56'
                  network: BASE
                  label: My Wallet address
                  dateAdded: '2026-03-18T17:08:52.374Z'
                  lastUpdated: '2026-03-18T17:08:52.374Z'
        '400':
          description: Whitelist limit reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                status: 400
                message: Whitelist limit reached
                data: {}
components:
  parameters:
    CustomerIdHeader:
      name: customer-id
      in: header
      required: true
      description: The merchant customer this request acts on behalf of.
      schema:
        type: string
      example: 665f1b2c9a1e4d0012ab3c01
  schemas:
    ApiError:
      type: object
      description: Standard error envelope.
      properties:
        status:
          type: integer
          example: 400
        message:
          type: string
          example: Action not allowed
        data:
          type: object
          example: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your secret key as a Bearer token. The key prefix selects the
        environment: `sk_test_...` (test) or `sk_live_...` (live).

````