Skip to main content

List Files

Suggest Edits

Overview​

Retrieve a paginated list of all File resources. This endpoint returns metadata about files including their upload status, type, and linked resources.

Resource Access​

Production (api.ahrvo.network)

GET https://api.ahrvo.network/payments/na/files

Staging (gateway.ahrvo.network)

GET http://gateway.ahrvo.network/payments/na/files

Arguments​

AttributeMandatory / OptionalDescription
limitOptionalThe number of items to return (default: 10)
created_at.gteOptionalFilter files created on or after the given date (ISO 8601 format)
after_cursorOptionalReturn every resource created after the cursor value

Example Request​

curl -X GET "https://gateway.ahrvo.network/payments/na/files?limit=10&created_at.gte=2025-12-01T00:00:00Z" \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic <base64_encoded_credentials>"

Example Response​

{
  "_embedded": {
    "files": [
      {
        "id": "FIxxxxxxxxxxxxxxxxxx",
        "status": "UPLOADED",
        "created_at": "2025-12-10T17:00:00Z",
        "updated_at": "2025-12-10T17:05:00Z",
        "linked_type": "MERCHANT",
        "linked_to": "MRxxxxxxxxxxxxxxxxxx",
        "extension": "pdf",
        "display_name": "Bank Statement (December 2025)",
        "type": "BANK_STATEMENT",
        "size_in_bytes": 245678,
        "file_name": "bank_statement_dec_2025.pdf",
        "tags": {
          "month": "2025-12",
          "purpose": "merchant_onboarding"
        },
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/files/FIxxxxxxxxxxxxxxxxxx"
          }
        }
      },
      {
        "id": "FIyyyyyyyyyyyyyyyyyy",
        "status": "UPLOADED",
        "created_at": "2025-12-08T14:30:00Z",
        "updated_at": "2025-12-08T14:32:00Z",
        "linked_type": "MERCHANT",
        "linked_to": "MRxxxxxxxxxxxxxxxxxx",
        "extension": "pdf",
        "display_name": "PCI Compliance Certificate",
        "type": "PCI_DOCUMENT",
        "size_in_bytes": 89234,
        "file_name": "pci_certificate.pdf",
        "tags": {
          "year": "2025",
          "certification_level": "SAQ_A"
        },
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/files/FIyyyyyyyyyyyyyyyyyy"
          }
        }
      },
      {
        "id": "FIzzzzzzzzzzzzzzzzzz",
        "status": "REQUIRES_UPLOAD",
        "created_at": "2025-12-10T16:45:00Z",
        "updated_at": "2025-12-10T16:45:00Z",
        "linked_type": "MERCHANT",
        "linked_to": "MRzzzzzzzzzzzzzzzzzz",
        "extension": null,
        "display_name": "W9 Tax Form",
        "type": "TAX_DOCUMENT",
        "size_in_bytes": null,
        "file_name": null,
        "tags": {
          "tax_year": "2025"
        },
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/files/FIzzzzzzzzzzzzzzzzzz"
          },
          "upload": {
            "href": "https://api.ahrvo.network/payments/na/files/FIzzzzzzzzzzzzzzzzzz/upload"
          }
        }
      }
    ]
  },
  "page": {
    "offset": 0,
    "limit": 10,
    "count": 3
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/files?limit=10&created_at.gte=2025-12-01T00:00:00Z"
    }
  }
}

Understanding File Status​

Files in the list may have different statuses:

  • REQUIRES_UPLOAD: File resource created but content not yet uploaded (includes upload link)
  • PENDING: File uploaded and being processed
  • UPLOADED: File successfully uploaded and available (includes extension, size, and filename)

API Documentation​