Skip to content
English
Customer portal
eComCharge Blog
  • There are no suggestions because the search field is empty.

Get the list of processed transactions

Warning

DWH v.1 is no longer supported and will soon be deactivated. Please use DWH v.2 instead.

Use these requests to get the list of processed transactions:

  • GET request;
  • POST request: use this request if the number of symbols of the request URL exceeds the maximum allowed value;
  • POST request (deprecated): the data can be sorted by the date, transaction status and payment method type.

GET request

Request

The requests must:

Send a GET request to {YOUR DWH URL}/api/v1/transactions with the following parameters:

Parameter Type Description
response_type * required string A response data type.

To get details of processed transactions, set to transactions.
response_parameters string Transaction parameters that should be sent in the response. Submit as a string of values separated with commas.

For possible values, see the table below.
date_from * required string A start date of the reporting period in the YYYY-MM-DD hh:mm:ss format, for example 2020-01-01 12:00:00.

The date must occur within 90 days before the value of the date_to parameter.
date_to * required string An end date of the reporting period in the YYYY-MM-DD hh:mm:ss format, for example 2020-01-01 12:00:00.

The date must occur within 90 days after the value of the date_from parameter.
date_type string A date type.

Possible values:
created_at is a date when a transaction is created (set by default);
paid_at is a date when a transaction is paid;
settled_at is a date when a transaction is cleared;
updated_at is a date when a transaction is updated;
manually_corrected_at is a date when transaction details are manually corrected.
time_zone string The name of the timezone used to parse dates in the request and the response as defined here, for example Europe/London.

Default value is Etc/UTC.
merchant_id string A string of comma-separated merchant IDs to count the number of processed transactions.

Don't send along with shop_id.
shop_id string A string of comma-separated shop IDs to count the number of processed transactions.

Don't send along with merchant_id.
gateway_id string A string of comma-separated payment gateway IDs to count the number of processed transactions.
transaction_type string A string of comma-separated transaction types to count the number of processed transactions.

Possible values:
authorization,
payment,
tokenization,
payout,
capture,
void,
refund,
credit,
chargeback.
payment_method_type string A string of comma-separated payment method types to count the number of processed transactions.

Possible values:
credit_card stands for card payment methods;
alternative stands for non-card-based payment methods.
status string A string of comma-separated transaction statuses to count the number of processed transactions.

Possible values:
successful,
failed,
incomplete,
error,
pending.
currency string A string of comma-separated transaction currencies to count the number of processed transactions in the ISO-4217 format, for example USD.
brand string A string of comma-separated payment brands to count the number of processed transactions, for example visa.
agent_id string A string of comma-separated agent IDs to count the number of processed transactions.
token_provider string A string of comma-separated token providers to count the number of processed transactions, for example apple_pay.
merchant_country string A string of comma-separated merchant countries to count the number of processed transactions in the ISO 3166-1 alpha-2 format.
gateway_type string A string of comma-separated names of payment gateway providers and acquirers to count the number of processed transactions, for example Bogus.
limit integer The number of transactions in a response.

Minimum allowed value: 1.
Maximum allowed value: 10000.
Default value is 1000.

Request example

curl -v "{YOUR DWH URL}/api/v1/transactions?response_type=transactions&date_type=created_at&gateway_type=Bogus&date_from=2022-07-13 06:59:55&date_to=2022-08-13 00:00:00&response_parameters=payment_method_type,paid_at,merchant_id" \
    -H "Authorization: Basic MTpwc3BfMV9rZXk=" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Response

The response contains the following parameters:

Parameter Type Description
data object A section of transaction report parameters.
has_next_page * required boolean The parameter indicating that there are more transactions that meet the request parameters than those sent in the response.

Possible values:
true, if there are more transactions that meet the request parameters;
false, if all the transactions that meet the request parameters are sent in the response.
next_value_for_date_from * required string A date of the next transaction that meets the request parameters, but is not sent in the response. The date is of the type submitted in the date_type request parameter.

To get more transactions that are not included in the response, send the received date value as a value of the date_from parameter in the request.
transactions array An array of transactions that meet the request parameters. Each element represents a transaction object with mandatory parameters and those parameters listed in the response_parameters of the request.
created_at * required string A date when a transaction is created.
id * required integer A transaction identifier in the system.

Response example

{
    "data": {
        "has_next_page": false,
        "transactions": [
            {
                "created_at": "2022-07-13T07:00:30.649123",
                "id": 42628,
                "merchant_id": 54,
                "paid_at": "2022-07-13T07:00:37.911234",
                "payment_method_type": "credit_card"
            },
            {
                "created_at": "2022-07-13T07:00:39.193345",
                "id": 42629,
                "merchant_id": 62,
                "paid_at": "2022-07-13T07:00:41.371456",
                "payment_method_type": "credit_card"
            },
            {
                "created_at": "2022-07-13T07:00:42.958567",
                "id": 42630,
                "merchant_id": 54,
                "paid_at": "2022-07-13T07:00:45.097678",
                "payment_method_type": "credit_card"
            }
        ]
    }
}

POST request

Request

The requests must:

Send a POST request to {YOUR DWH URL}/api/v1/transactions with the following parameters:

Parameter Type Description
response_type * required string A response data type.

To get the number of transactions, set to transactions.
response_parameters string A string of one or more transaction parameters that should be sent in the response. Submit the array as a string of values separated with commas.

For possible values, see the table below.
date_from * required string A start date of the reporting period in the YYYY-MM-DD hh:mm:ss, for example 2020-01-01 12:00:00.

The date must occur within 90 days before the value of the date_to parameter.
date_to * required string An end date of the reporting period in the YYYY-MM-DD hh:mm:ss, for example 2020-01-01 12:00:00.

The date must occur within 90 days after the value of the date_from parameter.
date_type string A date type.

Possible values:
created_at is a date when a transaction is created (set by default);
paid_at is a date when a transaction is paid;
settled_at is a date when a transaction is cleared;
updated_at is a date when a transaction is updated;
manually_corrected_at is a date when transaction details are manually corrected.
time_zone string The name of the timezone used to parse dates in the request and the response as defined here, for example Europe/London.

Default value is Etc/UTC.
merchant_id string A string of comma-separated merchant IDs.

Don't send along with shop_id.
shop_id string A string of comma-separated shop IDs.

Don't send along with merchant_id.
gateway_id string A string of comma-separated payment gateway IDs.
transaction_type string A string of comma-separated transaction types.

Possible values:
authorization,
payment,
tokenization,
payout,
capture,
void,
refund,
credit,
chargeback.
payment_method_type string A string of comma-separated payment method types.

Possible values:
credit_card stands for card payment methods;
alternative stands for non-card-based payment methods.
status string A string of comma-separated transaction statuses.

Possible values:
successful,
failed,
incomplete,
error,
pending.
currency string A string of comma-separated transaction currencies in the ISO-4217 format, for example USD.
brand string A string of comma-separated payment brands, for example, visa.
agent_id string A string of comma-separated agent IDs.
token_provider string A string of comma-separated token providers, for example, apple_pay.
merchant_country string A string of comma-separated merchant countries in the ISO 3166-1 alpha-2 format.
gateway_type string A string of comma-separated payment gateway providers and acquirers, for example, Bogus.
limit integer The number of transactions in the response.

Minimum allowed value: 1.
Maximum allowed value: 10000.
Default value is 1000.

Request example

{
    "response_type":"transactions",
    "response_parameters": "payment_method_type,paid_at,merchant_id",
    "date_type":"created_at",
    "date_from":"2022-06-06 10:30:25",
    "date_to":"2022-08-10 21:00:00",
    "gateway_type":"Bogus",
    "status":"successful,failed",
    "currency":"EUR,USD,RUB",
    "limit":5
}

Possible values of response_parameters

Parameter Description
id A system request identifier of a transaction.
uid A unique transaction identifier.
shop_id An identifier of the merchant's shop account.
merchant_id An identifier of the merchant account.
created_at A date and time when a transaction was created.
updated_at A date and time when a transaction was updated.
paid_at A date and time when a transaction was paid.
settled_at A date when a transaction was settled.
manually_corrected_at A date and time when a transaction was manually corrected.
expired_at A date and time when a transaction expires.
merchant_bank_id An identifier of a bank where a merchant keeps their current bank account.
merchant_company_name The name of the merchant's company.
merchant_country A country where the merchant's company is registered.
shop_name The name of the merchant's shop.
business_category A business category assigned to the merchant's shop.
gateway_id An identifier of a payment gateway enabled for the merchant's shop.
gateway_type The name of a payment gateway enabled for the merchant's shop.
agent_id An identifier of a merchant's agent account.
order_id An identifier of an order related to a transaction.
tracking_id An identifier assigned to the transaction in the merchant's system.
transaction_type A transaction type.
payment_method_type A payment method type.
payment_method_brand A payment method brand.
currency A transaction currency.
amount A transaction amount.
status A transaction processing status.
converted_currency A currency to which a transaction amount was converted.
converted_amount An amount of a transaction after conversion.
reason A reason note about a refunded or failed payment.
billing_descriptor A transaction billing description.
rrn A retrieval reference number assigned to a transaction.
message A message about transaction processing.
description A transaction description.
gateway_note A note about a payment gateway stated in the back office.
bank_code A processing status code assigned to a transaction by an acquiring bank.
ref_id A reference identifier of a transaction assigned to a transaction by an acquiring bank.
recurring_type A recurring type of the transaction.
response_code A response code.
card_bin A number of a card-issuing bank.
card_issuer_country A country of a card-issuing bank.
card_product A card brand or product.
card_first_1 The first 1 digit of a cardholder's card.
card_last_4 The last 4 digits of a cardholder's card.
card_holder_name A cardholder's name.
card_expiration A card expiry date.
token_provider A payment token provider.
three_d_secure_ve_status A verification status of card enrollment in the 3-D Secure program.
three_d_secure_pa_status A payment authentication status of the 3-D Secure check.
three_d_secure_eci A payment authentication code of the 3-D Secure check.
avs_cvc_verification_result A result code of the AVS/ CVC verification service.
auth_code An authorization code of a payment.
customer_ip The customer's IP address upon making a payment.
customer_email The customer's email address.
address_first_name The customer's first name.
address_middle_name The customer's middle name.
address_last_name The customer's last name.
address_address The customer's address.
address_country The customer's country.
address_city The customer's city.
address_zip The customer's zip number.
address_state The customer's state.
address_phone The customer's phone.

Response

The response contains the following parameters:

Parameter Type Description
data object A section of transaction report parameters.
has_next_page boolean The parameter indicating that there are more transactions that meet the request parameters than those sent in the response.

Possible values:
true, if there are more transactions that meet the request parameters.
false, if all the transactions that meet the request parameters are sent in the response.
next_value_for_date_from string A date of the next transaction that meets the request parameters, but is not sent in the response. The date is of the type submitted in the date_type request parameter.

To get more transactions that are not included in the response, send the received date value as a value of the date_from parameter in the request.
transactions array An array of transactions that meet the request parameters. Each element represents a transaction object with mandatory parameters and those parameters listed in the response_parameters of the request.
created_at * required string A date when a transaction is created.
id * required integer A transaction identifier in the system.

Response example

{
    "data": {
        "has_next_page": true,
        "next_value_for_date_from": "2022-06-06T14:34:14.073123",
        "transactions": [
            {
                "created_at": "2022-06-06T11:00:53.887234",
                "id": 36643,
                "merchant_id": 54,
                "paid_at": "2022-06-06T11:00:57.046345",
                "payment_method_type": "credit_card"
            },
            {
                "created_at": "2022-06-06T11:39:42.779456",
                "id": 36644,
                "merchant_id": 48,
                "paid_at": "2022-06-06T11:39:45.940567",
                "payment_method_type": "credit_card"
            },
            {
                "created_at": "2022-06-06T12:00:49.679678",
                "id": 36647,
                "merchant_id": 54,
                "paid_at": "2022-06-06T12:00:54.871789",
                "payment_method_type": "credit_card"
            },
            {
                "created_at": "2022-06-06T13:00:45.360890",
                "id": 36685,
                "merchant_id": 54,
                "paid_at": "2022-06-06T13:00:47.615901",
                "payment_method_type": "credit_card"
            },
            {
                "created_at": "2022-06-06T14:00:55.411123",
                "id": 36707,
                "merchant_id": 54,
                "paid_at": "2022-06-06T14:01:01.580234",
                "payment_method_type": "credit_card"
            }
        ]
    }
}

POST request (deprecated)

Request

The requests must:

  • use HTTP Basic authentication with x as a username and your PSP secret key as a password;
  • have a body with parameters in the JSON or XML formats, or as an HTML form data;
  • have the Content-Type header set to application/json or application/xml depending on the request body format;
  • have the Accept header set to application/json or application/xml depending on the preferred response format;
  • have the X-Api-Version header set to 3;
  • be UTF-8 encoded.

Send a POST request to {YOUR_BACKOFFICE_URL}/api/psp/reports with the following parameters:

Parameter Type Description
report_params object A section of transaction report parameters.
date_type * required string A date type.

Possible values:
created_at is a date when a transaction is created,
paid_at is a date when a transaction is paid,
settled_at is a date when a transaction is cleared.
from * required string A start date of the reporting period in the YYYY-MM-DD hh:mm:ss format, e.g. 2020-01-01 12:00:00.

For the settled_at date type, set the date in the YYYY-MM-DD format.
to * required string An end date of the reporting period in the YYYY-MM-DD hh:mm:ss format, e.g. 2020-01-01 15:00:00.

For the settled_at date type, set the date in the YYYY-MM-DD format.
status * required string A transaction status.

Possible values:
all,
successful,
failed,
pending,
incomplete.
payment_method_type * required string A payment method.

Possible values:
credit_card stands for card payment methods,
alternative stands for non-card-based payment methods.
time_zone * required string A timezone name as defined here, e.g. Europe/London.
starting_after string The forward pagination parameter.

Accepts the value last_object_id from the response.
ending_before string The reverse pagination parameter.

Accepts the value first_object_id from the response.
manual_correction_from string A start date of the reporting period with manually edited transactions in the YYYY-MM-DD hh:mm:ss format, e.g. 2020-01-01 12:00:00.
manual_correction_to string An end date of the reporting period with manually edited transactions in the YYYY-MM-DD hh:mm:ss format, e.g. 2020-01-01 15:00:00.

Request example

{
  "report_params": {
      "date_type":"created_at",
      "from":"2020-09-11 00:00:00",
      "to":"2020-09-11 23:59:59",
      "status":"successful",
      "payment_method_type":"credit_card",
      "time_zone":"UTC"
  }
}

Response

The response contains the following parameters:

Parameter Type Description
transactions * required array An array of transactions of the requested report. Each element represents a transaction object with its own set of parameters depending on the payment type and payment method used in this transaction.
count * required integer The total number of transactions in the requested report.
has_more * required boolean The parameter indicating that there are more transactions that meet the request parameters than those sent in the response.

Possible values:
true, if there are more transaction;
false, if all the transactions that meet the request parameters are included in the response.
first_object_id * required integer An identifier of the first transaction object returned in the response.
last_object_id * required integer An identifier of the last transaction object returned in the response.

Response example

{
    "transactions": [
        {
            "billing_address": {
                "first_name": null,
                "last_name": null,
                "address": null,
                "country": null,
                "city": null,
                "zip": null,
                "state": null,
                "phone": null,
                "birth_date": null
            },
            "customer": {
                "ip": "127.0.0.1",
                "email": null
            },
            "payment": {
                "gateway_id": 312,
                "ref_id": null,
                "message": null,
                "status": "incomplete",
                "gateway_name": "Demo",
                "auth_code": null,
                "bank_code": null,
                "rrn": null,
                "billing_descriptor": null
            },
            "credit_card": {
                "holder": "JJJJ",
                "token": "544ffa4a-d16f-4ebb-b390-d997c29858c9",
                "brand": null,
                "last_4": "0000",
                "first_1": "4",
                "bin": "420000",
                "issuer_country": "IT",
                "issuer_name": "INVESTBANK",
                "exp_month": 12,
                "exp_year": 2024,
                "product": "VISA"
            },
            "shop": {
                "id": 1
            },
            "gateway_note": "",
            "uid": "20528-f87e29fa35",
            "id": 28860,
            "payment_method_type": "credit_card",
            "status": "incomplete",
            "message": null,
            "amount": 1000,
            "discount_rate": 0.0,
            "transaction_rate": 0.0,
            "pay_to_merchant": 0.0,
            "transaction_fee": 0.0,
            "test": false,
            "currency": "USD",
            "description": "Test description",
            "tracking_id": null,
            "type": "payment",
            "order_id": 27724,
            "created_at": "2022-01-27T14:07:00Z",
            "paid_at": null,
            "settled_at": null,
            "manually_corrected_at": null,
            "additional_data": {
                "request_id": "cb8ada4d-59cb-49c5-b6c5-3e679dd2c7c7",
                "browser": {
                    "screen_width": 1440,
                    "screen_height": 900,
                    "screen_color_depth": 24,
                    "language": "it",
                    "java_enabled": false,
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.110 Safari/537.36",
                    "time_zone": -180,
                    "time_zone_name": "Europe/London",
                    "window_height": 666,
                    "window_width": 600,
                    "accept_header": "application/json"
                },
                "vendor": {
                    "name": "CTP",
                    "token": "18b3e6fe3d08edf84bb2fe60c9077c8b898a5bd58f7dc27cd2b286b6b10197d2"
                },
                "tdsecure": {
                    "status": "incomplete",
                    "message": "Authentication Available",
                    "ve_status": "Y",
                    "acs_url": "https://test.pc.com:8443/pareq/15524/003ec8b2-4bef-4036-84ba-f27721c99d86/",
                    "pa_req": "eJxVUtFy2jAQ/BVP3vFJslMwc9GMiRtCZkIpMCXpm7APYxJsIpsW/31PgJtWT7ennb3blXC5tUTJgtKjJY3PVNcmJ6/I7m5e5w8v4U8lF7civp/0B+OXZHajcRbP6UPjL7J1UZVa+sJXCB1kBZtuTdloNOnHaDLVkZQqihCuEPdkJ4mOuoNwaWBp9qTXdDBF5q9bhDPGtDqWjW01iyB0AI/2XW+b5lAPAXZ1r25MXpS5v6bcNPTbtH5a7QHB0RA+N5odXVWz7KnI9OrH03iVzM3z7mE5XY5G38Vb8O1rxrbjOwTHwIzltBJKCan6ngyHoj8UXxDOfTR7t4+WwhfCG71O2eOlgwc3KO6uhUD4t4OctaUybXUUBOyqQ0inQ1USM9jr3xozqlMd9JKFt6ms19iTp8StGvQ2gz6paGOCkBdyHIRPg/eP7gHShpOVQoYseEVuSMEZqtAlegUIjg/Xp+XEzr+Aq/9+xx/mJ7T7",
                    "md": "42877",
                    "pa_res_url": "{gateway_url}/process/20528-f87e29fa35",
                    "eci": null,
                    "pa_status": null,
                    "xid": null,
                    "cavv": null,
                    "cavv_algorithm": null,
                    "fail_reason": null,
                    "method_process_url": null
                },
                "avs_cvc": {
                    "avs_verification": {
                        "result_code": null
                    },
                    "cvc_verification": {
                        "result_code": null
                    }
                }
            },
            "three_d_secure_verification": {
                "eci": null,
                "pa_status": null,
                "xid": null,
                "cavv": null,
                "cavv_algorithm": null,
                "ve_status": "Y",
                "message": "Authentication Available",
                "status": "incomplete"
            }
        },
        {
            "billing_address": {
                "first_name": null,
                "last_name": null,
                "address": null,
                "country": null,
                "city": null,
                "zip": null,
                "state": null,
                "phone": null,
                "birth_date": null
            },
            "customer": {
                "ip": "79.98.55.24",
                "email": null
            },
            "payment": {
                "gateway_id": 312,
                "ref_id": null,
                "message": null,
                "status": "incomplete",
                "gateway_name": "Demo",
                "auth_code": null,
                "bank_code": null,
                "rrn": null,
                "billing_descriptor": null
            },
            "credit_card": {
                "holder": "IVAN IVANOV",
                "token": "3379480e-4c10-4dbd-83a3-7a14d16baf1f",
                "brand": null,
                "last_4": "0007",
                "first_1": "4",
                "bin": "420000",
                "issuer_country": "IT",
                "issuer_name": "INVESTBANK",
                "exp_month": 1,
                "exp_year": 2022,
                "product": "VISA"
            },
            "shop": {
                "id": 1
            },
            "gateway_note": "",
            "uid": "20529-66a8451797",
            "id": 28861,
            "payment_method_type": "credit_card",
            "status": "incomplete",
            "message": null,
            "amount": 1000,
            "discount_rate": 0.0,
            "transaction_rate": 0.0,
            "pay_to_merchant": 0.0,
            "transaction_fee": 0.0,
            "test": false,
            "currency": "USD",
            "description": "Test description",
            "tracking_id": null,
            "type": "payment",
            "order_id": 27725,
            "created_at": "2022-01-27T14:11:53Z",
            "paid_at": null,
            "settled_at": null,
            "manually_corrected_at": null,
            "additional_data": {
                "request_id": "9e97e8ad-54e6-487f-9bc0-eae0b497f73f",
                "browser": {
                    "screen_width": 1920,
                    "screen_height": 1080,
                    "screen_color_depth": 24,
                    "language": "it",
                    "java_enabled": false,
                    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:89.0) Gecko/20100101 Firefox/89.0",
                    "time_zone": -180,
                    "time_zone_name": "Europe/London",
                    "window_height": 666,
                    "window_width": 600,
                    "accept_header": "application/json"
                },
                "vendor": {
                    "name": "CTP",
                    "token": "179a4105e3f25b2c0ec3e6daf6135629f2fc4caf66667346ae5aeb776c958b4b"
                },
                "tdsecure": {
                    "status": "incomplete",
                    "message": "Authentication Available",
                    "ve_status": "Y",
                    "acs_url": "https://test.pc.com:8443/pareq/15525/a52d019a-440b-450a-b72c-67b24f02a56c/",
                    "pa_req": "eJxVUl1v4jAQ/CtR34k/AvSCFkvQqOpHgiCQVjwaZy+kVxJwQpv8+7MDoXd+mlmPZnfHhs1eIwZrVGeNAiKsKpmhk6fTu1X4kizDx9l8FUY8jrdeuA3uBCxnMZ4EfKGu8rIQzKUuB9JT46DVXha1AKlO8+eF8Bnjvg/kSuGA+jkQfn+AXApQyAOKHR5lnrq7FkjHQZXnotatMCZAegJn/Sn2dX2sJoR8VIOqllleZO4OM1njt2xdVR4IECsD8jPR8mxRZWybPBVJ0ry+vc2j+M/jg8GL6PNl/b5ZRO/JagrEKiA1doJTzinj9w4bThibjDwgXR3kwc4jGHUpdebbhdnxUoGjbTTrrykF8m8FTNYaC9UK3zNmNwbYHMsCjcLsesOQYqWENwjWzu9SO7VuHE5H3B+Mx/LXcMTu/bEZyGqA/Cz48GQfQNUmWUbZ0BhemW2SmwztTl0XS4BYPbk+rUms+wUG/fc7/gJV8bWH",
                    "md": "42878",
                    "pa_res_url": "{gateway_url}/process/20529-66a8451797",
                    "eci": null,
                    "pa_status": null,
                    "xid": null,
                    "cavv": null,
                    "cavv_algorithm": null,
                    "fail_reason": null,
                    "method_process_url": null
                },
                "avs_cvc": {
                    "avs_verification": {
                        "result_code": null
                    },
                    "cvc_verification": {
                        "result_code": null
                    }
                }
            },
            "three_d_secure_verification": {
                "eci": null,
                "pa_status": null,
                "xid": null,
                "cavv": null,
                "cavv_algorithm": null,
                "ve_status": "Y",
                "message": "Authentication Available",
                "status": "incomplete"
            }
        }
    ],
    "count": 2,
    "has_more": false,
    "first_object_id": 28860,
    "last_object_id": 28861
}

Pagination

If the has_more response parameter value is set to true, there are more transactions that meet the request parameters, but they are not included in the response. Use forward and reverse pagination to get a report on all the transactions.

For the forward pagination, send another report request with the same parameters, but add the starting_after parameter and set its value to last_object_id from the response.

For the reverse pagination, send another report request with the same parameters, but add the ending_before parameter and set its value to first_object_id from the response.