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

# Create payment route

> Creates a cross-chain payment route. Requires `api:write` scope and `Idempotency-Key`.



## OpenAPI

````yaml /openapi.yaml post /payment-routes
openapi: 3.1.0
info:
  title: Remitflex API
  version: 1.0.0
  description: >
    Programmatic access to Remitflex payment routes, fiat rates, customers, and
    transactions.


    **Dashboard:** Create API keys at https://dashboard.remitflex.io


    **Authentication:** Send your API key as `Authorization: Bearer
    rmf_live_...` or `rmf_test_...`.


    **Idempotency:** Mutating requests (`POST`, `PUT`, `PATCH`, `DELETE`)
    require an `Idempotency-Key` header when authenticated with an API key.
servers:
  - url: http://localhost:4000/v1
    description: Local development
  - url: https://api.remitflex.io/v1
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /payment-routes:
    post:
      tags:
        - Payment routes
      summary: Create payment route
      description: >-
        Creates a cross-chain payment route. Requires `api:write` scope and
        `Idempotency-Key`.
      operationId: createPaymentRoute
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentRouteRequest'
      responses:
        '201':
          $ref: '#/components/responses/PaymentRoute'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: >-
        Unique key for safe retries on mutating API-key requests. Cached for 24
        hours per org, method, and path.
      schema:
        type: string
        maxLength: 255
        example: 7f3c2a1b-4e5d-6c7b-8a9f-0e1d2c3b4a5f
  schemas:
    CreatePaymentRouteRequest:
      type: object
      required:
        - name
        - originChainKey
        - destinationChainKey
        - destinationCurrency
        - destinationAddress
      description: >
        Specify networks with `originChainKey` / `destinationChainKey`. Use
        token codes like `USDC` for `destinationCurrency`.
      properties:
        name:
          type: string
          minLength: 2
          maxLength: 80
        originChainKey:
          type: string
          description: >-
            Origin network key from `GET /payment-routes/chains` (e.g. `tron`,
            `bitcoin`).
        originCurrency:
          type: string
          minLength: 2
          maxLength: 128
          description: Optional token code on the origin network.
        destinationChainKey:
          type: string
          description: Settlement network — `base` or `solana`.
        destinationCurrency:
          type: string
          minLength: 2
          maxLength: 128
          description: >-
            Token code — `USDC` or `USDT` on Base; `USDC`, `USDT`, or `EURC` on
            Solana.
        destinationAddress:
          type: string
          minLength: 8
          maxLength: 128
        refundTo:
          type: string
          minLength: 8
          maxLength: 128
        strict:
          type: boolean
          default: false
        customerId:
          type: string
          minLength: 1
          maxLength: 128
        payerSource:
          type: string
          enum:
            - wallet
            - exchange
    SuccessEnvelope:
      type: object
      properties:
        status:
          type: string
          example: success
        message:
          type: string
        data:
          nullable: true
    PaymentRoute:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - active
            - archived
        customerId:
          type: string
        customerName:
          type: string
        origin:
          $ref: '#/components/schemas/NetworkEndpoint'
        destination:
          allOf:
            - $ref: '#/components/schemas/NetworkEndpoint'
            - type: object
              required:
                - address
              properties:
                address:
                  type: string
        refundTo:
          type: string
          nullable: true
        depositAddress:
          type: string
        relayRequestId:
          type: string
          nullable: true
        strict:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    NetworkEndpoint:
      type: object
      properties:
        key:
          type: string
        network:
          type: string
        symbol:
          type: string
        address:
          type: string
        acceptableTokens:
          type: array
          items:
            $ref: '#/components/schemas/TokenCode'
    TokenCode:
      type: object
      properties:
        symbol:
          type: string
        code:
          type: string
  responses:
    PaymentRoute:
      description: Payment route
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/SuccessEnvelope'
              - type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PaymentRoute'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >
        API key created in the Remitflex Dashboard at dashboard.remitflex.io
        (`rmf_live_...` or `rmf_test_...`).

        Key management endpoints require a dashboard JWT and are not part of
        this reference.

````