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

# Add Payer

> Adding a payer



## OpenAPI

````yaml /openapi/collections.json post /merchant/create-payer
openapi: 3.0.2
info:
  title: Flick Collections API
  description: This is a sample API Document for Flick services
  termsOfService: http://getflick.app/terms-conditions
  contact:
    email: kingsley@getflick.app
  license:
    name: FLICK
    url: http://www.getflick.app
  version: 1.0.17
servers:
  - url: https://flickopenapi.co
    description: For linking your banks to Flick
security:
  - bearerAuth: []
tags:
  - name: Virtual Account/IBANs
    description: iban Charging
    externalDocs:
      description: Find out more
      url: http://www.getflick.app
  - name: Card
    description: Card Charging
    externalDocs:
      description: Find out more
      url: http://www.getflick.app
  - name: Direct-debit
    description: Debit
    externalDocs:
      description: Find out more
      url: http://www.getflick.app
externalDocs:
  description: Find out more about Flick
  url: https://www.linkedin.com/company/getflick/
paths:
  /merchant/create-payer:
    post:
      tags:
        - ''
      summary: Add Payer
      description: Adding a payer
      operationId: Create payer
      requestBody:
        description: Payer details
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePayer'
        required: true
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePayerResponse'
        '400':
          description: Wrong Input
        '403':
          description: Unauthroized Access
        '405':
          description: Invalid input
        '500':
          description: Internal Server Error
      security:
        - bearerAuth: []
components:
  schemas:
    CreatePayer:
      required:
        - fullName
        - dob
        - idCard
        - residentialAddress
      type: object
      properties:
        fullName:
          type: string
          example: userFullName
        dob:
          type: string
          example: YYYY-MM-DD
        idCard:
          type: string
          description: max 5mb
          example: >-
            AMTQA2iiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD/2Q==
        residentialAddress:
          type: string
          example: 2b close off userLocation
        kycDetails:
          type: object
          required:
            - fullName
            - dob
            - idNumber
            - idType
          properties:
            fullName:
              type: string
              example: Kingsley Flick
            dob:
              type: string
              example: '2025-12-19'
            idType:
              type: string
              example: national_id
              description: '[idCard, passport, driverLicense, other'
            idNumber:
              type: string
              example: '1111222000'
    CreatePayerResponse:
      type: object
      properties:
        status:
          type: integer
          example: 200
        message:
          type: string
          example: Payer created successfully
        payerId:
          type: string
          example: e13-47a1-89d4-460bf99bd
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your live or test secret key, prefixed `sk-`. Send as `Authorization:
        Bearer sk-...`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.