---
updatedAt: 2026-09-28T18:23:56.000Z
agentTools:
  projectIndex: https://docs.helix.q2.com/llms.txt
---

# Get a fee record by customer fee tag

Retrieve the most recent fee lookup record for the given `customerFeeTag`.

#### Error Codes

<details>
  <summary>Click to expand</summary>

| Code    | Message (en-US)                    | Notes                                            |
| :------ | :--------------------------------- | :----------------------------------------------- |
| 1-60000 | Any "Common Error Code" may occur. | See [Common Error Codes](https://docs.helix.q2.com/reference/common-error-codes) |

</details>

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Helix API",
    "version": "3.0.0",
    "description": "Helix Public API (no customer KYC/IDV). **This spec covers all of Helix 3.x and is subject to change at any time.**"
  },
  "servers": [
    {
      "url": "https://sandbox-api.helix.q2.com",
      "description": "Sandbox server"
    },
    {
      "url": "https://api.helix.q2.com",
      "description": "Production server"
    }
  ],
  "tags": [
    {
      "name": "Card",
      "description": "Endpoints for the card object"
    },
    {
      "name": "Fee",
      "description": "Endpoints for the fee object"
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/card/lock": {
      "post": {
        "tags": [
          "Card"
        ],
        "summary": "Lock a card",
        "description": "Lock a card. Most locks can be reversed by calling [/card/unlock](https://docs.helix.q2.com/reference/cardunlock). Please check the [/card/unlock](https://docs.helix.q2.com/reference/cardunlock) documentation to see which lock scenarios can be subsequently unlocked. Will apply a `lockTypeCode` of `CST` on success and all card-based transactions will fail.",
        "externalDocs": {
          "url": "https://docs.helix.q2.com/reference/cardlock"
        },
        "operationId": "cardLock",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "customerId",
                  "cardId",
                  "lockReasonTypeCode"
                ],
                "properties": {
                  "customerId": {
                    "$ref": "#/components/schemas/HelixId"
                  },
                  "cardId": {
                    "$ref": "#/components/schemas/HelixId"
                  },
                  "lockReasonTypeCode": {
                    "type": "string",
                    "enum": [
                      "UNK",
                      "FRD",
                      "DMG",
                      "TMP"
                    ],
                    "description": "- `UNK`: Unknown\n- `FRD`: Fraud\n- `DMG`: Physical Damage\n- `TMP`: Temporary\n"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "An <a href=\"https://docs.helix.q2.com/reference/response-format\" target=\"_blank\">envelope</a> whose data node is a <a href=\"https://docs.helix.q2.com/docs/card\" target=\"_blank\">card</a> object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardObject200Response"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "code": {
                            "$ref": "#/components/schemas/HelixId"
                          },
                          "message": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    "requestId": {
                      "type": "string",
                      "example": "b75a96f8-2fbc-4b14-9ba4-7b06aa431c9d"
                    },
                    "status": {
                      "type": "integer",
                      "enum": [
                        400
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "integer",
                            "enum": [
                              50401
                            ]
                          },
                          "message": {
                            "type": "string",
                            "example": "User is not authorized"
                          }
                        }
                      }
                    },
                    "requestId": {
                      "type": "string",
                      "enum": [
                        "00000000-0000-0000-0000-000000000000"
                      ]
                    },
                    "status": {
                      "type": "integer",
                      "enum": [
                        401
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "integer",
                            "enum": [
                              50404
                            ]
                          },
                          "message": {
                            "type": "string",
                            "example": "The requested resource 'https://sandbox-api.helix.q2.com/customer/updat/805592' was not found"
                          }
                        }
                      }
                    },
                    "requestId": {
                      "type": "string",
                      "example": "b75a96f8-2fbc-4b14-9ba4-7b06aa431c9d"
                    },
                    "status": {
                      "type": "integer",
                      "enum": [
                        404
                      ]
                    }
                  }
                }
              }
            }
          },
          "405": {
            "description": "HTTP Method Not Allowed",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "integer",
                            "enum": [
                              50405
                            ]
                          },
                          "message": {
                            "type": "string",
                            "example": "The HTTP method 'POST' for requested resource 'https://sandbox-api.helix.q2.com/customer/get/805594' is not allowed."
                          }
                        }
                      }
                    },
                    "requestId": {
                      "type": "string",
                      "enum": [
                        "00000000-0000-0000-0000-000000000000"
                      ]
                    },
                    "status": {
                      "type": "integer",
                      "enum": [
                        405
                      ]
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Rate Limit Exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "integer",
                            "enum": [
                              50429
                            ]
                          },
                          "message": {
                            "type": "string",
                            "example": "Rate limit exceeded"
                          }
                        }
                      }
                    },
                    "requestId": {
                      "type": "string",
                      "enum": [
                        "00000000-0000-0000-0000-000000000000"
                      ]
                    },
                    "status": {
                      "type": "integer",
                      "enum": [
                        429
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/fee/getByCustomerTag/{customerFeeTag}": {
      "get": {
        "tags": [
          "Fee"
        ],
        "summary": "Get a fee record by customer fee tag",
        "description": "Retrieve the most recent fee lookup record for the given `customerFeeTag`.",
        "externalDocs": {
          "url": "https://docs.helix.q2.com/reference/feegetbycustomertag"
        },
        "operationId": "feeGetByCustomerTag",
        "parameters": [
          {
            "name": "customerFeeTag",
            "in": "path",
            "required": true,
            "description": "Customer-facing tag used for fee lookup and correlation. The value cannot be null, empty, or whitespace and has a maximum length of 128 characters.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          }
        ],
        "responses": {
          "200": {
            "description": "An <a href=\"https://docs.helix.q2.com/reference/response-format\" target=\"_blank\">envelope</a> whose data node is a fee lookup object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FeeLookupObject200Response"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1card~1lock/post/responses/400"
          },
          "401": {
            "$ref": "#/paths/~1card~1lock/post/responses/401"
          },
          "404": {
            "$ref": "#/paths/~1card~1lock/post/responses/404"
          },
          "405": {
            "$ref": "#/paths/~1card~1lock/post/responses/405"
          },
          "429": {
            "$ref": "#/paths/~1card~1lock/post/responses/429"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CardArray200Response": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "errors": {
                "type": "array",
                "items": {},
                "example": []
              },
              "requestId": {
                "type": "string",
                "example": "1249a3bf-aca1-40dd-9fba-2a3193550c39"
              },
              "status": {
                "type": "integer",
                "enum": [
                  200
                ]
              },
              "throttle": {
                "type": "object",
                "properties": {
                  "periodEndsAt": {
                    "$ref": "#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate"
                  },
                  "periodLengthInSeconds": {
                    "$ref": "#/components/schemas/HelixId"
                  },
                  "periodRequestLimit": {
                    "$ref": "#/components/schemas/HelixId"
                  },
                  "requestsRemainingInPeriod": {
                    "$ref": "#/components/schemas/HelixId"
                  },
                  "warningThreshold": {
                    "type": "number",
                    "format": "decimal",
                    "example": 0.2
                  }
                }
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CardObject200Response/allOf/1/properties/data"
                }
              }
            }
          }
        ]
      },
      "CustomerSetLastContact200Response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CardArray200Response/allOf/0"
          },
          {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "customerId": {
                      "$ref": "#/components/schemas/HelixId"
                    },
                    "dormancyStatus": {
                      "type": "string",
                      "enum": [
                        "Active",
                        "Inactive",
                        "Dormant"
                      ]
                    },
                    "lastContactDate": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2021-01-07T19:00:59.761-06:00"
                    },
                    "lastContactType": {
                      "$ref": "#/components/schemas/LastContactType"
                    }
                  }
                }
              }
            }
          }
        ]
      },
      "FeeLookupObject200Response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CardArray200Response/allOf/0"
          },
          {
            "type": "object",
            "properties": {
              "data": {
                "type": "object",
                "properties": {
                  "feeToApplyId": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Primary identifier of the fee work item."
                  },
                  "customerId": {
                    "$ref": "#/components/schemas/HelixId"
                  },
                  "accountId": {
                    "$ref": "#/components/schemas/HelixId"
                  },
                  "customerFeeTag": {
                    "type": "string",
                    "description": "Customer-facing tag used for lookup and correlation."
                  },
                  "masterId": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Transaction master identifier associated to the fee when available."
                  },
                  "transactionId": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Identifier of the fee transaction after the fee has posted."
                  },
                  "refundTransactionId": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Identifier of the refund transaction when a refund has posted."
                  },
                  "reversalTransactionIds": {
                    "type": "array",
                    "description": "Reversal transaction identifiers associated to this fee.",
                    "items": {
                      "type": "integer",
                      "format": "int64"
                    }
                  },
                  "reversalToApplyIds": {
                    "type": "array",
                    "description": "Reversal fee work-item identifiers associated to this fee.",
                    "items": {
                      "type": "integer",
                      "format": "int64"
                    }
                  },
                  "feeAmount": {
                    "type": "number",
                    "format": "decimal",
                    "description": "Fee amount recorded for the fee work item."
                  },
                  "transactionAmount": {
                    "type": "number",
                    "format": "decimal",
                    "description": "Posted transaction amount when available."
                  },
                  "feeToApplyState": {
                    "type": "integer",
                    "format": "int32",
                    "description": "Current internal fee state enum value."
                  },
                  "feeWaiverCode": {
                    "type": "string",
                    "description": "Waiver reason or waiver code when the fee was waived or partially waived."
                  },
                  "feeWaiverAmount": {
                    "type": "number",
                    "format": "decimal",
                    "description": "Waived amount for the fee."
                  }
                }
              }
            }
          }
        ]
      },
      "HelixId": {
        "type": "integer",
        "format": "int32",
        "minimum": 1
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-samples-languages": [
    "curl",
    "node",
    "python",
    "csharp",
    "ruby",
    "go",
    "java",
    "kotlin",
    "php"
  ]
}
```