> ## 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.

# Public pay page data

> No authentication. Returns payer-facing payment details.



## OpenAPI

````yaml /openapi.yaml get /pay/{id}
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:
  /pay/{id}:
    get:
      tags:
        - Payment links
      summary: Public pay page data
      description: No authentication. Returns payer-facing payment details.
      operationId: getPayPage
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          $ref: '#/components/responses/PayPage'
      security: []
components:
  responses:
    PayPage:
      description: Public pay page state
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/SuccessEnvelope'
              - type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PayPage'
          examples:
            awaitingOrigin:
              $ref: '#/components/examples/PayPageAwaitingOriginResponse'
            quoted:
              $ref: '#/components/examples/PayPageQuotedResponse'
  schemas:
    SuccessEnvelope:
      type: object
      properties:
        status:
          type: string
          example: success
        message:
          type: string
        data:
          nullable: true
    PayPage:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
        linkMode:
          $ref: '#/components/schemas/CollectionLinkMode'
        checkoutLinkId:
          type: string
          format: uuid
          nullable: true
        embedConfig:
          $ref: '#/components/schemas/EmbedConfig'
        pricingType:
          $ref: '#/components/schemas/CollectionPricingType'
        payerSource:
          type: string
          enum:
            - wallet
            - exchange
        paymentMethod:
          type: string
          enum:
            - deposit
            - connected_wallet
        supportsConnectedWallet:
          type: boolean
          description: >-
            True when the pay page offers connect wallet (EVM and Solana
            fixed-amount only).
        label:
          type: string
          nullable: true
        fromName:
          type: string
          nullable: true
        payeeName:
          type: string
          nullable: true
        payerFields:
          type: array
          items:
            $ref: '#/components/schemas/PayerFieldConfig'
        payerDetails:
          $ref: '#/components/schemas/PayerDetails'
          nullable: true
        logoUrl:
          type: string
          format: uri
          nullable: true
        receiveAmount:
          type: number
          nullable: true
        sendAmount:
          type: number
          nullable: true
        amount:
          type: number
          nullable: true
        origin:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/NetworkEndpoint'
        destination:
          $ref: '#/components/schemas/NetworkEndpoint'
        payOptions:
          type: array
          items:
            $ref: '#/components/schemas/PayOption'
        originSelected:
          type: boolean
        quoted:
          type: boolean
        needsOriginSelection:
          type: boolean
        canChangeOrigin:
          type: boolean
        expectedAmountOut:
          type: string
          nullable: true
        receivedAmountOut:
          type: string
          nullable: true
        refundTo:
          type: string
          nullable: true
        depositAddress:
          type: string
          nullable: true
        relayStatus:
          type: string
          nullable: true
        failReason:
          type: string
          nullable: true
        depositTxHash:
          type: string
          nullable: true
        successRedirectUrl:
          type: string
          format: uri
          nullable: true
        quoteValidUntil:
          type: string
          format: date-time
          nullable: true
          description: >-
            When the current fixed-price quote expires. Re-quote after this
            time.
        quotedAt:
          type: string
          format: date-time
          nullable: true
        quoteExpired:
          type: boolean
        isOpenAmount:
          type: boolean
        completedAt:
          type: string
          format: date-time
          nullable: true
        recoveryInfo:
          $ref: '#/components/schemas/PayPageRecoveryInfo'
        executeQuote:
          type: object
          description: >-
            Present for connected-wallet quotes — opaque Relay execution
            payload.
    CollectionLinkMode:
      type: string
      enum:
        - invoice
        - checkout
      description: >
        invoice — single-use link; one id tracks one payment (default).

        checkout — reusable parent URL; each payer quote creates a session
        child; parent stays active.
    EmbedConfig:
      type: object
      properties:
        layout:
          type: string
          enum:
            - default
            - minimal
            - compact
          default: default
        accentColor:
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
        backgroundColor:
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
        textColor:
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
        mutedTextColor:
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
        borderColor:
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
        borderRadius:
          type: integer
          minimum: 0
          maximum: 32
        fontFamily:
          type: string
        hideBrandFooter:
          type: boolean
        hideStepIndicator:
          type: boolean
        hideMerchantBanner:
          type: boolean
        labels:
          $ref: '#/components/schemas/EmbedLabels'
    CollectionPricingType:
      type: string
      enum:
        - fixed
        - open
    PayerFieldConfig:
      type: object
      required:
        - key
        - required
      properties:
        key:
          $ref: '#/components/schemas/PayerFieldKey'
        required:
          type: boolean
          default: false
        label:
          type: string
          minLength: 1
          maxLength: 120
          description: >-
            Required for `metadata` fields — the prompt shown to the payer (e.g.
            Tax ID).
    PayerDetails:
      type: object
      properties:
        name:
          type: string
          maxLength: 120
        email:
          type: string
          maxLength: 254
        phone:
          type: string
          maxLength: 32
        kyc:
          $ref: '#/components/schemas/PayerKycDetails'
        metadata:
          type: object
          additionalProperties:
            type: string
            maxLength: 500
          description: Custom field values keyed by the label configured on the link.
    NetworkEndpoint:
      type: object
      properties:
        key:
          type: string
        network:
          type: string
        symbol:
          type: string
        address:
          type: string
        acceptableTokens:
          type: array
          items:
            $ref: '#/components/schemas/TokenCode'
    PayOption:
      type: object
      properties:
        key:
          type: string
        name:
          type: string
        originNetworkKey:
          type: string
        originNetwork:
          type: string
        originSymbol:
          type: string
        addressFormat:
          type: string
          enum:
            - evm
            - solana
            - bitcoin
            - tron
        minDepositUsd:
          type: number
    PayPageRecoveryInfo:
      type: object
      properties:
        message:
          type: string
        recoveryUrl:
          type: string
          format: uri
    EmbedLabels:
      type: object
      properties:
        continueButton:
          type: string
        sentButton:
          type: string
        checkAgainButton:
          type: string
        modalTitle:
          type: string
    PayerFieldKey:
      type: string
      enum:
        - name
        - email
        - phone
        - kyc
        - metadata
    PayerKycDetails:
      type: object
      properties:
        documentType:
          type: string
          maxLength: 64
        documentNumber:
          type: string
          maxLength: 128
        country:
          type: string
          maxLength: 64
    TokenCode:
      type: object
      properties:
        symbol:
          type: string
        code:
          type: string
  examples:
    PayPageAwaitingOriginResponse:
      value:
        status: success
        message: Pay page fetched
        data:
          id: a1b2c3d4-e5f6-7890-abcd-ef1234567891
          status: awaiting_origin
          linkMode: invoice
          checkoutLinkId: null
          embedConfig:
            layout: default
          pricingType: fixed
          payerSource: wallet
          paymentMethod: deposit
          supportsConnectedWallet: true
          label: 'Invoice #1042'
          fromName: null
          payeeName: Acme Ltd
          logoUrl: null
          receiveAmount: 500
          sendAmount: null
          amount: 500
          origin: null
          destination:
            key: solana
            network: Solana
            symbol: USDC
          payOptions:
            - key: tron-solana-usdc
              name: Tron USDT → Solana USDC
              originNetworkKey: tron
              originNetwork: Tron
              originSymbol: USDT
              addressFormat: tron
              minDepositUsd: 5
            - key: bitcoin-solana-usdc
              name: Bitcoin → Solana USDC
              originNetworkKey: bitcoin
              originNetwork: Bitcoin
              originSymbol: BTC
              addressFormat: bitcoin
          originSelected: false
          quoted: false
          needsOriginSelection: true
          canChangeOrigin: false
          expectedAmountOut: null
          receivedAmountOut: null
          refundTo: null
          depositAddress: null
          relayStatus: null
          failReason: null
          depositTxHash: null
          successRedirectUrl: null
          quoteValidUntil: null
          quotedAt: null
          quoteExpired: false
          isOpenAmount: false
          completedAt: null
          recoveryInfo:
            message: >-
              If payment fails, funds return to your return address on the
              origin network.
            recoveryUrl: https://relay.link/withdraw
    PayPageQuotedResponse:
      value:
        status: success
        message: Payment quote ready
        data:
          id: a1b2c3d4-e5f6-7890-abcd-ef1234567891
          status: awaiting_deposit
          linkMode: invoice
          checkoutLinkId: null
          embedConfig:
            layout: default
          pricingType: fixed
          payerSource: wallet
          paymentMethod: deposit
          supportsConnectedWallet: true
          label: 'Invoice #1042'
          fromName: null
          payeeName: Acme Ltd
          logoUrl: null
          receiveAmount: 500
          sendAmount: 501.25
          amount: 501.25
          origin:
            key: tron
            network: Tron
            symbol: USDT
            acceptableTokens:
              - symbol: USDT
                code: USDT
          destination:
            key: solana
            network: Solana
            symbol: USDC
          payOptions:
            - key: tron-solana-usdc
              name: Tron USDT → Solana USDC
              originNetworkKey: tron
              originNetwork: Tron
              originSymbol: USDT
              addressFormat: tron
              minDepositUsd: 5
          originSelected: true
          quoted: true
          needsOriginSelection: false
          canChangeOrigin: true
          expectedAmountOut: '500'
          receivedAmountOut: null
          refundTo: TYourTronRefundAddressExample123456789
          depositAddress: TDepositAddressExample1234567890abcdef
          relayStatus: null
          failReason: null
          depositTxHash: null
          successRedirectUrl: null
          quoteValidUntil: '2026-06-26T09:01:30.000Z'
          quotedAt: '2026-06-26T09:00:30.000Z'
          quoteExpired: false
          isOpenAmount: false
          completedAt: null
          recoveryInfo:
            message: >-
              If payment fails, funds return to your return address on the
              origin network.
            recoveryUrl: https://relay.link/withdraw
  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.

````