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

# Create pay-in

> Ask a customer to pay you. Returns the details the customer pays to.



## OpenAPI

````yaml /openapi.json post /v1/payins
openapi: 3.0.0
info:
  title: Payve API
  version: v1
  description: >-
    Send, collect and convert money across African corridors. Amounts are
    integers in minor units.
servers:
  - url: https://sandbox.api.payvehq.com
    description: Sandbox
  - url: https://api.payvehq.com
    description: Live
security:
  - api-key: []
tags:
  - name: quotes
    description: Lock an exchange rate and fee before you move money.
    x-group: Quotes
  - name: payouts
    description: Send money to bank accounts and mobile money wallets.
    x-group: Payouts
  - name: payins
    description: Collect money from a payer.
    x-group: Pay-ins
  - name: payment-links
    description: Hosted checkout pages you can share.
    x-group: Payment links
  - name: conversions
    description: Move a balance from one of your wallets to another currency.
    x-group: Conversions
  - name: wallets
    description: Balances and virtual accounts.
    x-group: Wallets
  - name: beneficiaries
    description: Saved payout recipients.
    x-group: Beneficiaries
  - name: refunds
    description: Return a pay-in to the payer.
    x-group: Refunds
  - name: statements
    description: Statement files for your wallets.
    x-group: Statements
  - name: webhooks
    description: Read your endpoints and delivery history.
    x-group: Webhooks
  - name: reference-data
    description: Currencies, indicative rates, banks and operators. No key needed.
    x-group: Reference data
paths:
  /v1/payins:
    post:
      tags:
        - payins
      summary: Create pay-in
      description: Ask a customer to pay you. Returns the details the customer pays to.
      operationId: PayinsController_initiate
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitiatePayinDto'
      responses:
        '202':
          description: Payin initiated
      security:
        - api-key: []
components:
  schemas:
    InitiatePayinDto:
      type: object
      properties:
        currency:
          type: string
          enum:
            - NGN
            - GHS
            - KES
        amount:
          type: number
          description: Expected amount in minor units
          example: 100000
        method:
          type: string
          enum:
            - bank_transfer
            - card
            - mobile_money
            - eft
            - virtual_account
        customer:
          $ref: '#/components/schemas/CustomerDto'
        merchantReference:
          type: string
        card:
          $ref: '#/components/schemas/CardDto'
        phone:
          type: string
          example: '+2348012345678'
        operator:
          type: string
          enum:
            - mtn
            - airtel
            - m-pesa
            - vodacom
            - orange
        callbackUrl:
          type: string
          example: https://merchant.example.com/payins/callback
        metadata:
          type: object
      required:
        - currency
        - amount
        - method
        - customer
        - merchantReference
    CustomerDto:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        phone:
          type: string
      required:
        - name
    CardDto:
      type: object
      properties:
        number:
          type: string
          description: Primary account number (PAN)
          example: '5061460410120223210'
        expiryMonth:
          type: string
          description: Expiry month (MM)
          example: '12'
        expiryYear:
          type: string
          description: Expiry year (YY or YYYY)
          example: '26'
        cvv:
          type: string
          description: CVV / CVC
          example: '123'
        holderName:
          type: string
          description: Cardholder name as printed on card
      required:
        - number
        - expiryMonth
        - expiryYear
        - cvv
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Your secret key. It starts with sk_test_ or sk_live_.

````