---
title: "Transaction Vault API"
canonical: "https://docs.pbs.org/space/TVA/5177349/Transaction%20Vault%20API"
format: markdown
---
> Macro (toc)
> Macro (children)
## Prerequisites
Before using the Transaction Vault you will need to obtain API Keys from PBS. Please [click here to submit a support ticket](https://digitalsupport.pbs.org/support/tickets/new) and request an API key. You must have a separate API key for each platform on which TVault is applied.
In your support ticket please specify:
- which PBS station(s) you need to access
- if you need read or write permissions, or both
- how many API keys you'll need. NOTE: (1) we recommend one key per client for tracking and security purposes. (2) we also recommend that each key have the minimum amount of permissions required.
> ⚠️ You must have a separate API key for each platform on which TVault is applied (e.g.: web, mobile, etc.)
## API Endpoints
See the Swagger documentation for all endpoints: [https://tvault-staging.services.pbs.org/api/swagger/](https://tvault-staging.services.pbs.org/api/swagger/)
## HTTP Response Status Codes
The following are possible status codes returned by responses to the API calls.
| **Status code** | **Meaning** | **Resolution** |
| --- | --- | --- |
| 200 | Success | Operation was successful |
| 204 | Success No content | The request was successful but the client doesn't need to leave the current page |
| 400 | Bad request | Description of the error will be given in the payload |
| 401 | Unauthenticated consumer | The consumer with this key:secret pair doesn’t exist in the system |
| 403 | Unauthorized consumer | The consumer with the key:secret doesn’t have access to this resource |
| 404 | No resources found | The demanded resources can not be found |
| 409 | Conflict | According to existing business logic, the request would cause a conflict and so it can’t be carried out |
| 500 | Internal server error | Unknown error |
## Monitoring your Stripe integration
The [Developers](https://dashboard.stripe.com/developers) section of the Dashboard provides you with useful information about the performance and health of your integration. You can view your API and webhook usage with real time charts, upgrade your API version, and review API errors that can be filtered by endpoint or type.
Stripe [logs](https://dashboard.stripe.com/logs) every successful or failed request made using your API keys. Each log contains details about the original request, whether it succeeded or failed, the response from Stripe, and a reference to any related API resources.
Every [event](https://stripe.com/docs/api#events) that takes place on your account can also be reviewed in the [Dashboard](https://dashboard.stripe.com/events). Events represent a change to an API resource (e.g., a Charge object is created or updated), and contains its current information.
