Audit API
The Audit API allows you to fetch the history of the actions that a user performed in the system.
Users with a PaymentsOS account can perform actions in the system, in accordance with the role(s) to which they belong. Actions include, for example, initiating a transaction through the Virtual Terminal, performing a payment search or generating a report. For auditing purposes, PaymentsOS tracks and stores the actions that a user performed. You can use the Audit API to retrieve those actions.
API Reference
Click here to view the Audit API Reference.
Audited Actions
The following table lists the type of actions that PaymentsOS keeps tracks of. The action type is returned in the action_type field included in the response of the Retrieve Audit Data API request. For each action type, the table also lists the resource in which the action was created.
| Action Type | Description | Created in Resource |
|---|---|---|
| activate_account | The user activated the PaymentsOS account in order to gain access to their Live environment. | activations |
| capture | The user initiated a Capture request from a payment record returned through the results of a payment search. | payment |
| charge | The user charged a customer through the Virtual Terminal. | payment |
| create_business_unit | The user created a new Business Unit. | app |
| create_customer | The user created a new customer through the Virtual Terminal. | customer |
| create_decision_engine_flow | The user created a new Decision Engine flow. | flow |
| create_payment | The user initiated a transaction through the Virtual Terminal (under the hood, PaymentsOS creates a Payment Request). | payment |
| create_payment_method | The user used the Virtual Terminal to create a new payment method for a customer. | payment_method |
| create_provider_configuration | The user created a new provider configuration. | processor_configuration |
| create_report_template | The user created a report template. | template |
| create_token | The user initiated a transaction through the Virtual Terminal (under the hood, PaymentsOS creates a new Token Request). | token |
| create_webhook_configuration | The user created a new webhook configuration. | webhook_configuration |
| deactivate_decision_engine_flow | The user deactivated a Decision Engine flow by deleting all decision engine rules. | flow |
| delete_webhook_configuration | The user deleted a webhook configuration. | webhook_configuration |
| generate_report | The user generated a report. | report |
| get_customer | The user retrieved a customer's details through the Virtual Terminal. | customer |
| get_payment | The user viewed a payment record returned through the results of a payment search. | payment |
| get_payment_methods | The user retrieved a customer's payment methods through the Virtual Terminal. | payment |
| invite_user | The user invited another person to join the team on PaymentsOS. | user |
| refund | The user initiated a Refund request from a payment record returned through the results of a payment search. | payment |
| replace_authentication_keys | The user replaced the API authentication keys in a Business Unit's configuration settings. | app |
| search_payments | The user searched payment records using the payment search functionality. | payment |
| update_business_unit | The user updated a Business Unit's configuration settings. | app |
| update_provider_configuration | The user updated the provider configuration settings. | processor_configuration |
| update_user_permissions | The user changed another user's permissions by assigning that user to another role or Business Unit (or by removing that user from a role or Business Unit). | user |
| update_webhook_configuration | The user updated the webhook configuration settings. | update_webhook_configuration |
| user_accepts_invite | A person invited to join PaymentsOS accepted the invite. | user |
| void | The user initiated a Void request from a payment record returned through the results of a payment search. | payment |
Last modified April 29, 2024