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

# Retrieve a Flutterwave v4 order charge by checkout reference

> Resolves a stored order charge from its checkout reference, validates the client, program, session and checkout flow, then delegates to charge retrieval to refresh the provider status. Use after returning from provider authorization when the checkout reference is available.



## OpenAPI

````yaml get /frontend/flutterwave-v4/order-charge-reference/{client_id}/{program_id}/{reference}/{session_id}
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity sponsorship relationships, lifecycle transitions, and
      sponsorship-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Client
    description: Client
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Files
    description: Files
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
paths:
  /frontend/flutterwave-v4/order-charge-reference/{client_id}/{program_id}/{reference}/{session_id}:
    get:
      tags:
        - Payments
      summary: Retrieve a Flutterwave v4 order charge by checkout reference
      description: >-
        Resolves a stored order charge from its checkout reference, validates
        the client, program, session and checkout flow, then delegates to charge
        retrieval to refresh the provider status. Use after returning from
        provider authorization when the checkout reference is available.
      operationId: retrieveFlutterwaveV4OrderChargeByReference
      parameters:
        - name: client_id
          in: path
          description: Client owning the stored checkout charge.
          required: true
          schema:
            type: integer
          example: 207
        - name: program_id
          in: path
          description: Anchor program id stored with the charge.
          required: true
          schema:
            type: integer
          example: 11
        - name: reference
          in: path
          description: >-
            Checkout reference returned by charge initialization and preserved
            across the provider redirect.
          required: true
          schema:
            type: string
          example: FWV4-207-11-checkout
        - name: session_id
          in: path
          description: >-
            Optional frontend session id; when supplied it must match the stored
            charge session.
          required: true
          schema:
            type: string
          example: checkout-session
      responses:
        '200':
          description: Current charge status, identifiers and any next action.
          content:
            application/json:
              schema:
                type: object
        '404':
          description: >-
            The checkout reference, charge state or selected recipient is
            unavailable.
        '500':
          description: Unexpected checkout retrieval failure.
        '502':
          description: Flutterwave provider retrieval failed.
      security: []

````

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