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

# Retrieve funding information

> Retrieves a real-time overview of your account balance by currency.



## OpenAPI

````yaml /api-reference/openapi.yaml get /funds
openapi: 3.1.0
info:
  title: Giftbit API
  version: v1
  description: >
    Giftbit's REST API lets you automatically order rewards and send them to
    your

    recipients. Delivery can be handled either by links that integrate into
    another

    system's workflow, or by emails sent through the Giftbit system.


    Authenticate every request with a bearer token in the `Authorization`
    header.

    Only an HTTP `200` means success; all non-`200` responses share a common
    error body.
  contact:
    name: Giftbit Support
    email: testbed@giftbit.com
    url: https://www.giftbit.com/api-documentation
servers:
  - url: https://api-testbed.giftbit.com/papi/v1
    description: Testbed
  - url: https://api.giftbit.com/papi/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Ping
    description: Test your authentication and check the health of the Giftbit API.
  - name: Brands
    description: List reward brands and retrieve extended information about a single brand.
  - name: Regions
    description: List the regions used to filter brands and request Full Catalog rewards.
  - name: Email Orders
    description: Order one or more rewards delivered to recipients by Giftbit email.
  - name: Shortlink Orders
    description: Order branded shortlink rewards that include a customized landing page.
  - name: Direct Link Orders
    description: >-
      Order minimally branded direct link rewards returned immediately in the
      response.
  - name: Embedded Rewards
    description: >-
      Order a single in-app reward for immediate delivery in your app or
      website.
  - name: Funds
    description: Retrieve your account balance and top it up with a credit card payment.
  - name: Rewards
    description: List, retrieve, resend, and cancel individual rewards.
paths:
  /funds:
    get:
      tags:
        - Funds
      summary: Retrieve funding information
      description: Retrieves a real-time overview of your account balance by currency.
      operationId: retrieve-funding-information
      responses:
        '200':
          description: Fund information retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundsResponse'
              example:
                info:
                  code: INFO_FUNDS
                  name: Fund information retrieved
                  message: Your current fund information was retrieved.
                fundsbycurrency:
                  USD:
                    available_in_cents: 196525
                    pending_in_cents: 0
                    reserved_in_cents: 41500
                  CAD:
                    available_in_cents: 6600
                    pending_in_cents: 0
                    reserved_in_cents: 1000
                  PRO:
                    available_in_cents: 0
                    pending_in_cents: 0
                    reserved_in_cents: 0
components:
  schemas:
    FundsResponse:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/Info'
        fundsbycurrency:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CurrencyFunds'
    Info:
      type: object
      description: Status information returned on successful requests.
      properties:
        code:
          type: string
          description: An enum-style status code for the request.
        name:
          type: string
          description: Human-readable status name.
        message:
          type: string
          description: Request-context-specific message.
    CurrencyFunds:
      type: object
      properties:
        available_in_cents:
          type: integer
          description: Available funds — your purchasing power for new reward orders.
        pending_in_cents:
          type: integer
          description: Funds sent by you but not yet fully processed by Giftbit.
        reserved_in_cents:
          type: integer
          description: >-
            Funds held to cover outstanding, unclaimed reward offers within
            their claim period.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Send your API token prefixed by `Bearer ` in the `Authorization` header.

````