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

# Create a checkout

> Creates a payment in your currency and returns a `checkoutUrl` for a page we host. Your customer pays in USDC or USDT on the network they choose; we convert at the current rate when they pick a token.

Fulfil the order when you receive the `checkout.completed` webhook, not when the customer reaches your `redirectUrl`.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/transaction/initialize
openapi: 3.0.0
info:
  title: Flipeet Pay API
  version: '1.0'
  description: >-
    Accept and send stablecoin and local-currency payments. Authenticate with
    your secret key in the x-api-key header. Keys starting fpay_test_ use the
    sandbox; fpay_live_ moves real money. Guides: https://docs.flipeet.io
  contact:
    name: Flipeet Pay
    url: https://docs.flipeet.io
servers:
  - url: https://api.pay.flipeet.io
security:
  - x-api-key: []
tags:
  - name: Checkout
    description: >-
      Hosted payment pages: create a payment, send your customer to checkoutUrl,
      and get a webhook when they pay.
  - name: Deposits
    description: >-
      Collect stablecoins or local currency straight into your balance, with
      your own UI.
  - name: Balance
    description: What you hold, per asset.
  - name: Withdrawals
    description: Send funds from your balance to a wallet or a bank account.
  - name: Ramps
    description: >-
      Convert between local currency and stablecoins for your own customers,
      settled to their wallet or bank.
  - name: Webhooks
    description: Delivery history, resends and test events.
  - name: Sandbox
    description: 'Test-mode tools: simulate outcomes and add test funds. Sandbox keys only.'
paths:
  /api/v1/transaction/initialize:
    post:
      tags:
        - Checkout
      summary: Create a checkout
      description: >-
        Creates a payment in your currency and returns a `checkoutUrl` for a
        page we host. Your customer pays in USDC or USDT on the network they
        choose; we convert at the current rate when they pick a token.


        Fulfil the order when you receive the `checkout.completed` webhook, not
        when the customer reaches your `redirectUrl`.
      operationId: TransactionController_initializePayment
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitializeMerchantTransactionDto'
            example:
              amount: 25000
              currency: NGN
              email: ada@example.com
              memo: 'Order #1042'
              reference: order_1042
              redirectUrl: https://shop.example.com/thanks
      responses:
        '201':
          description: Payment session created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Transaction initialized successfully
                  status:
                    type: string
                    example: success
                  statusCode:
                    type: number
                    example: 201
                  data:
                    type: object
                    properties:
                      amount:
                        type: number
                        example: 25000
                      currency:
                        type: string
                        example: NGN
                      checkoutUrl:
                        type: string
                        example: https://pay.flipeet.io/checkout?ref=fp_8f2k3m
                      payerEmail:
                        type: string
                        example: ada@example.com
                      memo:
                        type: string
                        example: 'Order #1042'
                      mode:
                        type: string
                        example: live
                      reference:
                        type: string
                        example: order_1042
                      txRef:
                        type: string
                        example: fp_8f2k3m
                      theme:
                        type: string
                        example: light
                      status:
                        type: string
                        example: pending
              example:
                message: Transaction initialized successfully
                status: success
                statusCode: 201
                data:
                  amount: 25000
                  currency: NGN
                  checkoutUrl: https://pay.flipeet.io/checkout?ref=fp_8f2k3m
                  payerEmail: ada@example.com
                  memo: 'Order #1042'
                  mode: live
                  reference: order_1042
                  txRef: fp_8f2k3m
                  theme: light
                  status: pending
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
      security:
        - x-api-key: []
components:
  schemas:
    InitializeMerchantTransactionDto:
      type: object
      properties:
        amount:
          type: number
          description: The amount to charge, in `currency`.
          example: 25000
        currency:
          type: string
          description: The currency you price in.
          example: NGN
          enum:
            - USD
            - NGN
            - GHS
            - KES
            - UGX
            - TZS
            - XOF-BEN
            - XOF-CIV
        email:
          type: string
          description: Your customer's email, for their receipt.
          example: ada@example.com
        memo:
          type: string
          description: What the payment is for. Shown on the checkout page.
          example: 'Order #1042'
        reference:
          type: string
          description: >-
            Your own ID for the payment, such as an order ID. It comes back in
            the webhook.
          example: order_1042
        redirectUrl:
          type: string
          description: Where the customer goes after paying.
          example: https://shop.example.com/thanks
        theme:
          type: string
          default: light
          description: The checkout page's colour scheme.
          example: light
          enum:
            - light
            - dark
      required:
        - amount
        - currency
  responses:
    Error400:
      description: The request is invalid. `details.errors` lists every problem.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: What went wrong, for people. May be reworded.
              status:
                type: string
                example: error
              statusCode:
                type: integer
                description: The HTTP status.
              code:
                type: string
                description: A stable code to branch on.
                enum:
                  - invalid_request
                  - authentication_failed
                  - permission_denied
                  - not_found
                  - conflict
                  - rate_limited
                  - internal_error
                  - provider_error
              details:
                type: object
                nullable: true
                description: For validation errors, `errors` lists every problem.
              requestId:
                type: string
                description: Quote it when you contact us.
              timestamp:
                type: string
                format: date-time
          example:
            message: Amount must be a positive number
            status: error
            statusCode: 400
            code: invalid_request
            details:
              errors:
                - Amount must be a positive number
            requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b
            timestamp: '2026-11-04T10:00:00.000Z'
    Error401:
      description: The API key is missing, mistyped or revoked.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: What went wrong, for people. May be reworded.
              status:
                type: string
                example: error
              statusCode:
                type: integer
                description: The HTTP status.
              code:
                type: string
                description: A stable code to branch on.
                enum:
                  - invalid_request
                  - authentication_failed
                  - permission_denied
                  - not_found
                  - conflict
                  - rate_limited
                  - internal_error
                  - provider_error
              details:
                type: object
                nullable: true
                description: For validation errors, `errors` lists every problem.
              requestId:
                type: string
                description: Quote it when you contact us.
              timestamp:
                type: string
                format: date-time
          example:
            message: Invalid or inactive API key
            status: error
            statusCode: 401
            code: authentication_failed
            details: null
            requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b
            timestamp: '2026-11-04T10:00:00.000Z'
    Error429:
      description: Too many requests. Each key can make 120 a minute.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: What went wrong, for people. May be reworded.
              status:
                type: string
                example: error
              statusCode:
                type: integer
                description: The HTTP status.
              code:
                type: string
                description: A stable code to branch on.
                enum:
                  - invalid_request
                  - authentication_failed
                  - permission_denied
                  - not_found
                  - conflict
                  - rate_limited
                  - internal_error
                  - provider_error
              details:
                type: object
                nullable: true
                description: For validation errors, `errors` lists every problem.
              requestId:
                type: string
                description: Quote it when you contact us.
              timestamp:
                type: string
                format: date-time
          example:
            message: Too many requests. Slow down and try again shortly.
            status: error
            statusCode: 429
            code: rate_limited
            details: null
            requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b
            timestamp: '2026-11-04T10:00:00.000Z'
    Error500:
      description: Something went wrong on our side. Retry with backoff.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: What went wrong, for people. May be reworded.
              status:
                type: string
                example: error
              statusCode:
                type: integer
                description: The HTTP status.
              code:
                type: string
                description: A stable code to branch on.
                enum:
                  - invalid_request
                  - authentication_failed
                  - permission_denied
                  - not_found
                  - conflict
                  - rate_limited
                  - internal_error
                  - provider_error
              details:
                type: object
                nullable: true
                description: For validation errors, `errors` lists every problem.
              requestId:
                type: string
                description: Quote it when you contact us.
              timestamp:
                type: string
                format: date-time
          example:
            message: Internal server error
            status: error
            statusCode: 500
            code: internal_error
            details: null
            requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b
            timestamp: '2026-11-04T10:00:00.000Z'
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your secret key. `fpay_test_…` keys use the sandbox; `fpay_live_…` keys
        move real money.

````

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