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

# Get a Payment Request

> Re-read a reference issued by `request-payload`: the same body, with a live
`status` — `open` while it can still be used, `consumed` once a payment was
created from it, `expired` once `expires_at` has passed without one.



## OpenAPI

````yaml GET /v1/platform/payments/request-payload/{reference}
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: fees
  - name: onboarding
  - name: Redirect URLs
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: document mailing
  - name: merchant onboarding
  - name: catalog
  - name: webhooks
  - name: screening
  - name: Platform - File Scanning
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: Card Transfers
  - name: Accounting
  - name: embed-tokens
paths:
  /v1/platform/payments/request-payload/{reference}:
    get:
      tags:
        - payments
      summary: Read a payment request
      description: >-
        Re-read a reference issued by `request-payload`: the same body, with a
        live

        `status` — `open` while it can still be used, `consumed` once a payment
        was

        created from it, `expired` once `expires_at` has passed without one.
      operationId: >-
        read_payment_request_v1_platform_payments_request_payload__reference__get
      parameters:
        - name: reference
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Reference
            description: The reference `request-payload` returned.
          description: The reference `request-payload` returned.
      responses:
        '200':
          description: Payment request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
              example:
                status_code: 200
                data:
                  reference: 3f9c1b2a-9d84-4e15-8c26-0b7a5d3e1f90
                  status: open
                  expires_at: '2026-09-11T10:30:00Z'
                  source_type: wallet
                  destination_type: bank
                  payment_type: send
                  amount: 250
                  currency: USD
                  fee: 3
                  destinations_supported: false
                  fields:
                    reference:
                      required: true
                      requirements: []
                    idempotency_key:
                      required: true
                      requirements: []
                    wallet_id:
                      required: true
                      requirements: []
                    payee_destination_id:
                      required: true
                      requirements:
                        - field: bank_account_number
                          label: Bank account number
                        - field: last_name
                          label: Last name
                    user_id:
                      required: false
                      requirements: []
                    payment_category:
                      required: false
                      requirements: []
                    metadata:
                      required: false
                      requirements: []
                    from_hold:
                      required: false
                      requirements: []
                    notify_recipient:
                      required: false
                      requirements: []
                query_generated_time: 1712847600000
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    CommonResponse:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          title: Data
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
      title: CommonResponse
      description: |-
        Standard response wrapper for single-object responses and errors.

        Generic over the payload type. A route that declares
        ``CommonResponse[SomeModel]`` gets the real ``data`` schema rendered in
        OpenAPI/Swagger; a bare ``CommonResponse`` leaves ``data`` untyped.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````