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

# Create a payment request

> Create an open banking payment request. Returns a link token
that the organization should embed in their frontend.
The customer authorizes the payment through their bank.




## OpenAPI

````yaml openapi.json post /v1/payments
openapi: 3.0.0
info:
  title: Inflow API
  version: 1.0.0
  description: API service for managing customer cards
  contact:
    name: API Support
servers:
  - url: https://sandbox.inflowafrica.com/api
    description: Sandbox
  - url: https://app.inflowpay.net/api
    description: Production
  - url: http://localhost:3000/api
    description: Local
security:
  - bearerAuth: []
tags: []
paths:
  /v1/payments:
    post:
      tags:
        - External API - Payments
      summary: Create a payment request
      description: |
        Create an open banking payment request. Returns a link token
        that the organization should embed in their frontend.
        The customer authorizes the payment through their bank.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - targetAmount
                - sourceCurrency
                - targetCurrency
                - reference
                - customerId
              properties:
                targetAmount:
                  type: number
                  description: Payment target amount
                  example: 35000
                sourceCurrency:
                  type: string
                  description: ISO 4217 source currency code
                  example: EUR
                targetCurrency:
                  type: string
                  description: ISO 4217 target currency code (supported payout currency)
                  example: NGN
                description:
                  type: string
                  example: Monthly subscription
                reference:
                  type: string
                  description: Unique payment reference (required).
                customerId:
                  type: string
                  format: uuid
                  description: >-
                    Customer ID to associate the payment with a specific
                    customer (required).
                payerName:
                  type: string
                payerEmail:
                  type: string
                redirectUrl:
                  type: string
                  description: URL to redirect after payment authorization
                provider:
                  type: string
                  description: |
                    Open-banking provider. Defaults to the PAYMENT_PROVIDER env.
                paymentType:
                  type: string
                  description: Optional payment type hint (default DOMESTIC_PAYMENT).
                metadata:
                  type: object
      responses:
        '201':
          description: >
            Payment created. Returns a linkToken, checkoutUrl, or hosted
            paymentLink to share with the payer to authorise the payment.
        '400':
          description: Validation error
        '409':
          description: Duplicate reference
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter JWT token
    apiKeyAuth:
      type: http
      scheme: bearer
      description: Enter your API key starting with gtw_sk_

````