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

# List top-ups

> Money resellers put on their balance, paid on the store's checkout with its own payment methods, newest first, 25 a page. `state` is `paid`, `waiting` (for the reseller to pay), `checking` (paid with one of the store's custom methods, and waiting for the store), `expired` (not paid in the store's unpaid order time) or `taken_back` (its payment was taken back by the bank, and came off the balance). A top-up's `id` is the order it is paid with. `meta.counts` is how many in each state, and `meta.figures` the last 30 days'.

Needs the `resellers.read` permission (Read Resellers).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/resellers/top-ups
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Teams
  - name: Resellers
  - name: Blacklist
  - name: Allowlist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/resellers/top-ups:
    get:
      tags:
        - Resellers
      summary: List top-ups
      description: >-
        Money resellers put on their balance, paid on the store's checkout with
        its own payment methods, newest first, 25 a page. `state` is `paid`,
        `waiting` (for the reseller to pay), `checking` (paid with one of the
        store's custom methods, and waiting for the store), `expired` (not paid
        in the store's unpaid order time) or `taken_back` (its payment was taken
        back by the bank, and came off the balance). A top-up's `id` is the
        order it is paid with. `meta.counts` is how many in each state, and
        `meta.figures` the last 30 days'.


        Needs the `resellers.read` permission (Read Resellers).
      operationId: resellerTopUps.list
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - name: q
          in: query
          required: false
          description: >-
            Only what matches this text: an order's ID, a reseller's website, or
            who bought or paid.
          schema:
            type: string
        - name: reseller
          in: query
          required: false
          description: Only one reseller's, by their ID.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Only those in one state.
          schema:
            type: string
            enum:
              - paid
              - waiting
              - checking
              - expired
              - taken_back
        - name: page
          in: query
          required: false
          description: Which page of the list. The first is 1.
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        resellerId:
                          type: string
                        reseller:
                          type: string
                        resellerRemoved:
                          type: boolean
                        paidBy:
                          type: string
                        amount:
                          type: integer
                        currency:
                          type: string
                        state:
                          type: string
                        method:
                          type: string
                        createdAt:
                          type: string
                        paidAt:
                          nullable: true
                  pages:
                    type: integer
                  total:
                    type: integer
                  meta:
                    type: object
                    properties:
                      counts:
                        type: object
                        properties:
                          all:
                            type: integer
                          checking:
                            type: integer
                          paid:
                            type: integer
                          waiting:
                            type: integer
                          expired:
                            type: integer
                          taken_back:
                            type: integer
                      figures:
                        type: object
                        properties:
                          paid30:
                            type: integer
                          paidCount30:
                            type: integer
                          payers30:
                            type: integer
                          waiting:
                            type: integer
                          waitingCount:
                            type: integer
                          balanceHeld:
                            type: integer
                      currency:
                        type: string
              example:
                success: true
                message: null
                code: null
                data:
                  - id: 0d9f5h0p1yf-b0f7183f27c-1036611
                    resellerId: 5802fdf5-5c97-40bb-b505-29a900c278e4
                    reseller: keydepot.example.com
                    resellerRemoved: false
                    paidBy: team@keydepot.example.com
                    amount: 100
                    currency: USD
                    state: checking
                    method: Bank Transfer (EU)
                    createdAt: '2026-11-09 11:32:36'
                    paidAt: null
                  - id: 9e015h0p1y6-bd68d96dc00-1036610
                    resellerId: 5802fdf5-5c97-40bb-b505-29a900c278e4
                    reseller: keydepot.example.com
                    resellerRemoved: false
                    paidBy: team@keydepot.example.com
                    amount: 30
                    currency: USD
                    state: waiting
                    method: ''
                    createdAt: '2026-11-09 11:32:36'
                    paidAt: null
                pages: 1
                total: 2
                meta:
                  counts:
                    all: 2
                    checking: 1
                    paid: 0
                    waiting: 1
                    expired: 0
                    taken_back: 0
                  figures:
                    paid30: 0
                    paidCount30: 0
                    payers30: 0
                    waiting: 130
                    waitingCount: 2
                    balanceHeld: 37
                  currency: USD
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const page = await shoply.resellerTopUps.list();

            // Or every row of every page:
            for await (const row of shoply.resellerTopUps.list()) {
              console.log(row);
            }
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $page = $shoply->resellerTopUps->list();

            // Or every row of every page:
            foreach ($shoply->resellerTopUps->list() as $row) {
                print_r($row);
            }
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            page = client.resellerTopUps.list()

            # Or every row of every page:
            for row in client.resellerTopUps.list():
                print(row)
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

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