For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Real-Time Reporting - Guide

Learn how to reconcile transactions and get an audit trail of your account

Our reporting APIs can be used to reconcile transactions but can also provide a detailed audit trail for all activities that take place on your account. This guide focuses on transaction processing, specifically authorizations, to demonstrate how the outcome and data returned by the issuer are available in real time. Any subsequent actions performed on the transaction or authorization are also recorded and available in real time.

When you perform any action on any resource via our API, all of your data is instantly available to report on via GET methods. For example, you can pull a list of authentications, payment methods, or links based on particular search criteria. You can also obtain the details of a specific resource by using its specific identifier (ID).

Prerequisites

Before starting the steps in this guide, you must do the following:

Step 1: Get a list of transactions

In this step, we pull a list of transactions based on specific search criteria. There are a number of search options, including:

Card brand
Status
Last four digits of the card

Sample request

In this example, we use a date range to obtain a list of all the transactions processed on a specific day. For better readability, we limited our page size to 2. For available search parameters and details of all request and response variables, see Transactions in the API Explorer.

Sample response

{
    "total_record_count": 1155,
    "current_page_size": 2,
    "merchant_id": "MER_c4c0df11039c48a9b63701adeaa296c3",
    "merchant_name": "Sandbox_merchant_2",
    "account_id": "TRA_6716058969854a48b33347043ff8225f",
    "account_name": "Transaction_Processing",
    "filter": {
        "from_time_created": "2021-03-30T00:00:00.000Z",
        "to_time_created": "2021-03-30T23:59:59.999Z"
    },
    "paging": {
        "page_size": 2,
        "page": 1,
        "order": "DESC",
        "order_by": "TIME_CREATED"
    },
    "transactions": [
        {
            "id": "TRN_l52ksA9raoU4gp2T07ZfCSBzqVMar0",
            "time_created": "2021-03-30T23:40:23.311Z",
            "status": "PREAUTHORIZED",
            "type": "SALE",
            "channel": "CNP",
            "amount": "4500",
            "partner_amount": "",
            "merchant_amount": "",
            "currency": "GBP",
            "reference": "togWvZyfoSCkclYtcdEQ",
            "time_created_reference": "",
            "batch_id": "",
            "country": "",
            "payment_method": {
                "message": "SUCCESS",
                "entry_mode": "ECOM",
                "fingerprint": "",
                "fingerprint_presence_indicator": "",
                "name": "James Mason",
                "card": {
                    "brand": "VISA",
                    "authcode": "12345",
                    "brand_reference": "mjVPe4n3VwyLdpjU",
                    "masked_number_first6last4": "426397XXXXXX5262"
                }
            },
            "action_create_id": "ACT_l52ksA9raoU4gp2T07ZfCSBzqVMar0",
            "parent_resource_id": "TRN_l52ksA9raoU4gp2T07ZfCSBzqVMar0"
        },
        {
            "id": "TRN_vmSQBXLBZbpHpo8nDnPf91NQec8nEm",
            "time_created": "2021-03-30T23:39:08.180Z",
            "status": "PREAUTHORIZED",
            "type": "SALE",
            "channel": "CNP",
            "amount": "4500",
            "partner_amount": "",
            "merchant_amount": "",
            "currency": "GBP",
            "reference": "nFAqUCuoeCyXWHopjzlq",
            "time_created_reference": "",
            "batch_id": "",
            "country": "",
            "payment_method": {
                "message": "SUCCESS",
                "entry_mode": "ECOM",
                "fingerprint": "",
                "fingerprint_presence_indicator": "",
                "name": "MR FOO BAR",
                "card": {
                    "brand": "VISA",
                    "authcode": "12345",
                    "brand_reference": "7yzJ3NF4rKoCan3z",
                    "masked_number_first6last4": "426397XXXXXX5262"
                }
            },
            "action_create_id": "ACT_vmSQBXLBZbpHpo8nDnPf91NQec8nEm",
            "parent_resource_id": "TRN_vmSQBXLBZbpHpo8nDnPf91NQec8nEm"
        }
    ],
    "action": {
        "id": "ACT_zClF2MUwDM5ga7fvbZp2Owgv65ABfA",
        "type": "TRANSACTION_LIST",
        "time_created": "2022-03-31T10:59:01.516Z",
        "result_code": "SUCCESS",
        "app_id": "i9R0byBBor6RqTQNj3g4MuVBwH5rd7yR",
        "app_name": "demo_app"
    }
}

Step 2: Get the details of a specific transaction

When obtaining a list of transactions, a summary object is returned for each record. To pull the details of a specific transaction, we use its unique identifier. The response contains more data on the transaction, including specific variables and values passed as well as information on the payment method used.

For more information on all request and response variables, see Transactions in the API Explorer.

Sample request

Step 3: Get a list of actions associated with a transaction

Actions represent request and response messages sent by the merchant relating to a specific resource. In this step, we pull a list of actions related to one of the transactions returned previously.

There are a number of search criteria we could use, but here we just use a single resource ID: a transaction. In the response, there are two actions: the card being pre-authorized and the transaction being captured.

For more information on the available search parameters and the details of all request and response variables, see Actions in the API Explorer.

Sample request

Step 4: Get the details of a specific action

For additional logging or auditing purposes, it’s also possible to obtain the details of a specific action. This includes the message that was sent by the merchant to the API, the response that was sent back with details about the merchant, and the app that was used.

For more information on all request and response variables, see Actions in the API Explorer.

Sample request

Testing

Our Real-Time Data Reporting solution is available for testing in our free Sandbox environment for registered users of this developer portal. Use our resources below to start testing.

Test Cards

Test different transaction outcomes with simulated cards or banks.

Postman Collection

View, import, or fork our API collection in Postman.

Responses

View successful responses, HTTP status codes, action response data, and errors.

Integration references

To get a deeper understanding of Real-Time Data Reporting, we recommend that you use our provided integration references for both API and SDK integrations. For the full detailed API specification, see the API Explorer.

API /transactions

Create and retrieve payment links.

API /actions

Create and retrieve payment links.

SDKs & Libraries

Add server-side or client-side code to your integration.

Quickstart Demo

Demo how easy it is to integrate our customizable solutions into your existing payment experience, and view transactions from multiple channels and regions in one place.

Enhance your integration

Below are value-added services you can enable for Real-Time Data Reporting.

Settlement Reporting

Simplify reconciliation and get customized daily deposit data.

Disputes Management

Automate the reporting and management of transaction disputes

File Processing

Process large volumes of transactions in one file.

Real-Time Reporting - Guide | Global Payments