Skip to main content
Treasury Prime occasionally marks API fields as deprecated when they are being phased out in favor of a newer approach. Deprecated fields remain in API responses for backward compatibility but are scheduled for removal in a future version.

​
What “deprecated” means

A field marked as deprecated in the API reference schema:
  1. Temporarily still functions — The field continues to appear in API responses, and existing integrations that rely on it continue to work during the deprecation period.
  2. Should not be used in new integrations — New implementations should use the recommended replacement field or approach instead.
  3. Will be removed with advance notice — Before removing a deprecated field, Treasury Prime publishes a removal timeline in the changelog and notifies affected programs directly. After removal, requests that include the field may receive an HTTP 400 error.

​
How to identify deprecated fields

  • In the API reference, deprecated fields are annotated directly in the schema with a deprecated flag.
  • In the changelog, deprecation announcements include the affected field, timeline, and migration guidance.
  • Audit your integration for use of any deprecated fields.
  • Migrate to the replacement documented in the API reference or changelog.
  • Subscribe to the changelog RSS feed to receive advance notice of upcoming deprecations and removals.
If you have questions about a specific deprecated field or need migration assistance, contact Treasury Prime Support.