Transaction Reports

A transaction report provides a detailed breakdown of the transactions passing through your account. You can generate a transaction report in two ways: through the PaymentsOS Control Center, or using the Reporting API. The PaymentsOS Control Center, provides an intuitive user interface for defining a report, creating report templates and configuring reporting schedules. The Reporting API in contrast, allows you to extract the report data programmatically. This gives you some flexibility not available when creating a report through the Control Center UI. For instance, you can use the API to create more advanced filter criteria to increase the granularity of the data extracted to a report.

Transaction Report API Filter Values

Note

For an explanation of how to use a filter in the reporting API, see Filtering the Report Data.

Some filters are self-explanatory and do not require much elaboration to be understood. Others, however, require that you follow specific guidelines to ensure you pass in valid filter values. We listed those guidelines in the table below.

Some filters are self-explanatory and do not require much elaboration to be understood. Others, however, require that you follow specific guidelines to ensure you pass in valid filter values. We listed those guidelines in the table below.

Columns Guidelines
currency Must be a three character code in ISO-4217 format
  • transaction_amount
  • installments_first_payment_amount
  • installments_remaining_payments_amount
  • payment_amount
  • transaction_cost
Must be formatted in minor units.
card_country_code Must be formatted in in ISO 3166-1 alpha-3 format.
  • card_type
  • card_issuer
  • card_level
Must be one of the values returned in the relevant field of the Create Token request.
transaction_result_status Valid values: pending, succeed, failed, cancelled.
  • transaction_result_category
  • transaction_result_sub_category
For an overview of valid values, see Response Category and Response Sub-category in the Payments API Reference.
transaction_type Valid values: created, authorization, charge, capture, void, refund. Note: a transaction has a status of "created" when you invoke the Create Payment API request.
transaction_three_d_secure_result_type Valid values: internal or external.
transaction_three_d_secure_auth_status Valid values:
  • A: Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided
  • Y: Authentication/ Account Verification Successful
  • N: Not Authenticated /Account Not Verified; Transaction denied
  • R: Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification and requests that authorisation not be attempted.
  • R: Authentication/ Account Verification Could Not Be Performed; Technical or other problem
transaction_three_d_secure_result_version Valid values: 1.x.x or 2.x.x. Perform a payment search to see the version values returned in the transaction requests passing through your environment.
transaction_three_d_secure_result_eci Valid values:
  • 00: Returned by MasterCard. Authentication is unsuccessful or not attempted. The credit card is either a non-3D card or card issuing bank does not handle it as a 3D transaction.
  • 01: Returned by MasterCard. Either cardholder or card issuing bank is not 3D enrolled. 3D card authentication is unsuccessful.
  • 02: Returned by MasterCard. Both cardholder and card issuing bank are 3D enabled. 3D card authentication is successful.
  • 05: Returned by Visa ,JCB and Amex. Both cardholder and card issuing bank are 3D enabled. 3D card authentication is successful.
  • 06: Returned by Visa, JCB and Amex. Either cardholder or card issuing bank is not 3D enrolled. 3D card authentication is unsuccessful.
  • 07: Returned by Visa, JCB and Amex. Authentication is unsuccessful or not attempted. The credit card is either a non-3D card or card issuing bank does not handle it as a 3D transaction.
cof_transaction_indicators_card_entry_mode For an overview of valid values, see the cof_transaction_indicators.card_entry_mode field in the request body of a Create Authorization or Create Charge request.
user_email A support agent can initiate a transaction request on behalf of a customer (using the Virtual Terminal or through the Payment Search functionality). The user_email is the email address of the agent who initiated the transaction request.

results matching ""

    No results matching ""