Skip to main content

Update a Fee

Suggest Edits

Overview​

Update the tags (metadata) on a fee resource. Tags allow you to store additional information or categorization for fees, which can be useful for reporting, reconciliation, and tracking purposes.

Resource Access​

Production (api.ahrvo.network)

PUT https://api.ahrvo.network/payments/na/fees/\{fee_id}

Staging (gateway.ahrvo.network)

PUT http://gateway.ahrvo.network/payments/na/fees/\{fee_id}

Arguments​

AttributeMandatory / OptionalDescription
Finix-VersionMandatorySpecify the API version (e.g., 2022-02-01)
fee_idMandatoryThe unique ID of the fee to update
tagsMandatoryKey-value pairs of metadata to attach to the fee

Example Request​

curl -X PUT https://gateway.ahrvo.network/payments/na/fees/FExxxxxxxxxxxxxxxxxx \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic <base64_encoded_credentials>" \
  -H "Finix-Version: 2022-02-01" \
  -d '{
    "tags": {
      "billing_period": "2025-12",
      "department": "sales",
      "reviewed_by": "accounting_team",
      "approved": "true"
    }
  }'

Example Response​

{
  "id": "FExxxxxxxxxxxxxxxxxx",
  "created_at": "2025-12-10T16:00:00Z",
  "updated_at": "2025-12-10T17:15:00Z",
  "amount": 2500,
  "currency": "USD",
  "category": "PROCESSOR",
  "display_name": "December_Monthly_Service_Fee",
  "fee_subtype": "CUSTOM",
  "fee_type": "CUSTOM",
  "label": null,
  "linked_to": null,
  "linked_type": null,
  "merchant": "MRxxxxxxxxxxxxxxxxxx",
  "tags": {
    "billing_period": "2025-12",
    "department": "sales",
    "reviewed_by": "accounting_team",
    "approved": "true"
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/fees/FExxxxxxxxxxxxxxxxxx"
    },
    "merchant": {
      "href": "https://api.ahrvo.network/payments/na/merchants/MRxxxxxxxxxxxxxxxxxx"
    }
  }
}

Important Notes​

  • Tags Only: This endpoint only updates tags; other fee properties cannot be modified
  • Complete Replacement: The tags object completely replaces any existing tags
  • Immutable Amount: Fee amounts and types cannot be changed after creation
  • Updated Timestamp: The updated_at field will reflect when tags were last modified

Common Tag Use Cases​

  • Billing Periods: Track which billing cycle a fee belongs to
  • Departments: Categorize fees by business unit or department
  • Approval Status: Track review and approval workflows
  • Custom Categories: Add your own classification system
  • Reference Numbers: Link to external systems or invoices
  • Notes: Add context or explanations for the fee

API Documentation​