PCI Vault Logo
Admin

The endpoints in this section are all zero-rated and incur no cost.

GET /billing Get Month-To-Date Billing Information

Get your API spend for the current month to date.

GET
https://api.pcivault.io/v1/billing
# No Body
Response Code: 200 (example) 


GET /usage
Get Usage Statistics






Get your utilisation metrics for a given month.
The metrics contain the amounts of keys, tokens and API requests.


Note: The key and card metrics is always the current metric.
The API request metric will be for the supplied month.





(query)





The month for which to count API requests, defaults to the current month. Please specify the month in YYYY-MM format.








GET


https://api.pcivault.io/v1/usage






# No Body


Response Code: 200
(example)







POST /change-password
Change Your Basic Auth Password






Change your Basic Auth password.
We recommend doing this every month or so for added security.





(query)





The new password you want to use. There are no requirements, but we recommend a password of at least 32 characters in length. This field is only required when POSTing from the documentation, if you POST a raw html request without specifying a new password, one will be auto-generated.








POST


https://api.pcivault.io/v1/change-password






# No Body


Response Code: 200
(example)







GET /whoami
Get User and Version Information






Return the username as specified in basic auth,
and the current API environment information.


This endpoint is useful for testing if your basic auth works correctly.








GET


https://api.pcivault.io/v1/whoami






# No Body


Response Code: 200
(example)







GET /certificate
Get a Link to the PCI DSS Certificate






Get the latest signed PCI DSS certificate. This certificate is only available to paying users and should be treated as confidential.








GET


https://api.pcivault.io/v1/certificate






# No Body


Response Code: 200
(example)