Export the list of processed transactions
This method is similar to this one, but has a more simplified structure of filters and response parameters, and therefore requires less time to be executed.
Here are the main differences compared to the Get the list of processed transactions request.
- For the get list request, the recommended number of transactions to return (
options.limit) is 10–20, whereas for this request it's 100+ transactions. - No
options.time_zoneparameter. All dates in the response are returned in UTC timezone. - Different format of
response_parameters. Filtersupports fewer values.- If
commissionis specified inresponse_parameters, the response will return detailed information on the commissions applied to the transaction.
Request
The requests must:
- use HTTP Basic authentication with your PSP ID and secret key as a username and a password respectively;
- have the
Content-Typeheader set toapplication/json; - have the
Acceptheader set toapplication/json; - be UTF-8 encoded.
Send a POST request to {YOUR DWH URL}/api/v2/transactions/export with the following parameters:
| Parameter | Type | Description |
|---|---|---|
| response_parameters | string | A string of transaction parameters that need to be sent in the response. Format example: "response_parameters": "main,shop,gateway"Each value stands for a group of attributes. See more here. |
| options | object | |
| limit | integer | The number of transactions in the response. Minimum allowed value: 1.Maximum allowed value: 1000.Default value is 100. |
| sort_order | string | The order of transactions in the response. Possible values: asc (from the earliest to the latest) and desc (from the latest to the earliest). Default value is asc. |
| filter | object | |
| date_from * required | string | A start date of the reporting period in ISO 8601 format — YYYY-MM-DDThh:mm:ss, for example, 2024-01-24T23:13:39. The date must occur within 90 days before the value of the date_to parameter.Must equal next_date value from the response to the previous request if you send multiple requests for the same date range and the results don't fit into the limit specified in the first request. |
| uid_from * conditionally required | string | Required if you send multiple requests for the same date range and the results don't fit into the limit specified in the first request. Must equal next_uid value from the response to the previous request. |
| date_to * required | string | An end date of the reporting period in ISO 8601 format — YYYY-MM-DDThh:mm:ss, for example, 2024-01-25T23:13:39.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;updated_at is a date when a transaction is updated. |
| merchant_id | string | A string of merchant IDs. Submit as a string with a single or multiple values separated with commas. |
| shop_id | string | A string of shop IDs. Submit as a string with a single or multiple values separated with commas. |
| type | string | A string of transaction types for which the data needs to be returned in the response. Submit as a string with a single or multiple values separated with commas. Possible values: authorization,payment,tokenization,payout,capture,void,refund,credit,chargeback. |
| test | boolean | By default, false. If true, the data on test transactions will be returned. |
| currency | string | Transaction currency. Submit as a string with a single or multiple values separated with commas. The values must be in the ISO-4217 format, for example, USD. |
| gateway_id | string | Identifier(s) of payment gateway(s) enabled for the merchant's shop. Submit as a string with a single or multiple integer values separated with commas. |
| method_type | string | A payment method. Possible values: credit_card stands for card payment methods;alternative stands for non-card-based payment methods. |
Request example
{
"response_parameters": "main,gateway",
"filter": {
"date_from": "2024-06-19T00:00:00",
"date_to": "2024-06-30T00:02:00",
"date_type": "created_at",
"type": "payment",
"test": "false",
"currency": "EUR"
},
"options": {
"sort_direction": "desc",
"limit": 2
}
}
Response attribute groups
Main: includes all route attributes that are not nested objects: amount, converted_amount, converted_currency, closed_at, code, created_at, currency, description, expired_at, fraud, friendly_message, language, manually_corrected_at, merchant_id, message, paid_at, parent_uid, product_id,psp_settled_at, reason, recurring_type, shop_id, settled_at, status, subscription_id, test, tracking_id, type, updated_at, uid.
The other groups are nested objects and if specified in response_parameters in the request, the response will include the corresponding nested attributes: shop, merchant, gateway, provider_raw, links, three_d_secure_verification, method, customer, recipient, be_protected_verification (deprecated service), smart_routing_verification, avs_cvc_verification, provider_response, additional_data, commission, adjustments.
Response
Response example
{ "data": { "transactions": [ { "amount": 3000, "closed_at": null, "code": null, "converted_amount": null, "converted_currency": null, "created_at": "2024-06-28T14:21:12.792000Z", "currency": "EUR", "description": "description", "expired_at": "2025-01-01T14:00:00.000000Z", "fraud": null, "friendly_message": "Transaction was initialized.", "gateway": { "agent_id": null, "id": 4146, "note": null, "type": "SWPAlternative", "vendor": "beyag" }, "language": null, "manually_corrected_at": null, "merchant_id": 1245, "message": "Transaction was initialized.", "paid_at": null, "parent_uid": null, "product_id": null, "reason": null, "recurring_type": null, "settled_at": null, "shop_id": 1871, "status": "pending", "subscription_id": null, "test": false, "tracking_id": "9379992", "type": "payment", "uid": "4964ef24-82cb-4f66-99f7-5ae8fd2385f2", "updated_at": "2024-06-28T14:21:14.245000Z" }, { "amount": 3000, "closed_at": null, "code": null, "converted_amount": null, "converted_currency": null, "created_at": "2024-06-28T14:01:06.842000Z", "currency": "EUR", "description": "description", "expired_at": "2025-01-01T14:00:00.000000Z", "fraud": null, "friendly_message": "Transaction was initialized.", "gateway": { "agent_id": null, "id": 4146, "note": null, "type": "SWPAlternative", "vendor": "beyag" }, "language": null, "manually_corrected_at": null, "merchant_id": 1245, "message": "Transaction was initialized.", "paid_at": null, "parent_uid": null, "product_id": null, "reason": null, "recurring_type": null, "settled_at": null, "shop_id": 1871, "status": "pending", "subscription_id": null, "test": false, "tracking_id": "9379992", "type": "payment", "uid": "c64424f1-e65d-4ed7-95b7-0128ce329963", "updated_at": "2024-06-28T14:01:08.218000Z" } ], "pagination": { "date_from": "2024-06-28T14:21:12.792000Z", "date_to": "2024-06-28T14:01:06.842000Z", "date_type": "created_at", "has_next_page": true, "uid_from": "4964ef24-82cb-4f66-99f7-5ae8fd2385f2", "next_date": "2024-06-28T14:00:29.654000Z", "next_uid": "08d75a4e-6b17-4088-a9a2-81b10e93310a", "uid_to": "c64424f1-e65d-4ed7-95b7-0128ce329963" } }}
The parameters of main group
This parameter group includes all root transaction parameters.
| Parameter | Type | Description |
|---|---|---|
| amount | bigInteger | Transaction amount. |
| code | string | Transaction processing result code. |
| closed_at | datetime | The date when the transaction was closed. |
| converted_amount | bigInteger | The converted amount in the quote currency in minimal currency units. Sent if the converter service is activated. |
| converted_currency | string | Quote currency in ISO-4217 format. Sent if the converter service is activated. |
| created_at | datetime | Date and time when a transaction was created in the PSP system. |
| currency | string | Transaction currency in ISO-4217, or cryptocurrency. |
| description | string | Transaction description. |
| expired_at | datetime | Date and time until the payment can be made for the transaction. |
| fraud | string | Fraud check result. Possible values: reject - the transaction was rejected, for example, if the card's BIN is in the blacklist,review - the transaction is under review of the PSP. |
| friendly_message | string | A message for the customer with the transaction processing result. |
| language | string | The language of the payment page. |
| manually_corrected_at | datetime | A date and time when a transaction was manually corrected. |
| merchant_id | integer | The identifier of the merchant. |
| message | string | A message for the customer with the transaction processing result. |
| paid_at | datetime | Date and time when the payment was made for the transaction. |
| parent_uid | string | The identifier of the parent transaction in the PSP system. |
| product_ id | integer | The identifier of the subscription plan corresponding to the transaction. |
| psp_settled_at | datetime | Date and time of the transaction settlement between the PSP and the merchant. |
| reason | string | A reason note about a refunded or failed payment. |
| recurring_type | string | Recurring payment type used when paying with the saved cards. Possible values: recurring,initial,null,d_moto. |
| shop_id | integer | The identifier of the shop. |
| settled_at | datetime | Date and time of the transaction settlement between the acquirer and the merchant. |
| status | string | Transaction status. Possible values: successful,failed,incomplete,error,pending. |
| subscription_id | integer | The identifier of the subscription corresponding to the transaction. |
| test | boolean | If true, the transaction is a test one. |
| tracking_id | string | The identifier of the transaction in the merchant's system. |
| type | string | Transaction type. Possible values: authorization,payment,tokenization,payout,capture,void,refund,credit,chargeback. |
| updated_at | datetime | Date and time of the last transaction update in the PSP system. |
| uid | string | Unique transaction identifier in the PSP system. |
The parameters of shop group
This parameter group includes all the information about the shop, for which the transaction was made.
The example of shop group parameters
{ "shop": { "business_category_id": "5", "business_category_key": "it", "city": null, "company_name": "Demo Company", "contact_email": "demo_company@example.com", "contact_phone": "1234567890", "country": null, "created_at": "2024-08-05T10:54:08.201000Z", "enabled": true, "id": 1932, "legal_address": null, "mailing_address": null, "merchant_id": 1283, "name": "Demo", "postal_code": null, "psp_id": 1, "updated_at": "2025-03-26T10:46:16.933000Z", "url": "https://example.com" }}
| Parameter | Type | Description |
|---|---|---|
| business_category_id | string | The identifier of the shop's business category. |
| business_category_key | string | The name of the shop's business category. |
| city | string | The city where the shop is registered. |
| company_name | string | The name of the shop's company. |
| contact_email | string | The contact email of the shop. |
| contact_phone | string | The shop's phone number. |
| country | string | The country where the shop is registered. |
| created_at | datetime | Date and time when the shop was created. |
| enabled | boolean | If true, the shop entity is active (enabled in the shop settings). |
| id | string | The shop's identifier. |
| legal_address | string | The address where the shop is registered. |
| mailing_address | string | The mailing address of the shop. |
| merchant_id | string | The merchant's identifier. |
| name | string | The name of the shop. |
| postal_code | string | The postal code of the shop address. |
| psp_id | integer | The identifier of the PSP where the shop is registered. |
| updated_at | datetime | Date and time when the shop was last updated. |
| url | string | The website of the shop. |
The parameters of merchant group
This parameter group includes all the information about the merchant entity, for which the transaction was made.
The example of merchant group parameters
{ "merchant": { "bank_id": 1854, "city": "Vilnius", "company_name": "Demo Tests", "country": "LT", "created_at": "2023-11-30T12:35:39.928000Z", "email": "demo-test@example.com", "enabled": true, "id": 1253, "legal_address": null, "name": "Demo Shop", "postal_code": null, "psp_id": 1, "updated_at": "2025-02-12T07:19:41.112000Z" }}
| Parameter | Type | Description |
|---|---|---|
| bank_id | integer | The identifier of the merchant's bank. |
| city | string | The city where the merchant's company is registered. |
| company_name | string | The name of the merchant's company. |
| country | string | The country where the merchant is registered in the ISO 3166-1 alpha-2 format. |
| created_at | datetime | Date and time when the merchant was created. |
| string | The email of the merchant's company. Used to log into the merchant's account in the system. |
|
| enabled | boolean | If true, the merchant entity is active (enabled in the shop settings). |
| id | integer | Merchant's identifier in the PSP system. |
| legal_address | string | The address of the merchant's company. |
| name | string | The name of the merchant entity. |
| postal_code | string | The postal code of the merchant's company. |
| psp_id | integer | The identifier of the PSP where the merchant is registered. |
| updated_at | datetime | Date and time when the merchant was last updated. |
The parameters of gateway group
This parameter group includes information on the gateway/bank used for processing the transaction.
The example of gateway group parameters
{
"gateway": {
"agent_id": 1058,
"connection_type": null,
"id": 5102,
"note": null,
"type": "BankTransfer",
"vendor": "beyag"
}
}
| Parameter | Type | Description |
|---|---|---|
| agent_id | integer | Identifier of the agent assigned to the gateway. |
| connection_type | string | Gateway connection type. The value of the Connection type field in the gateway settings. As a rule, it contains keywords that are used for data grouping in the accounting reports. |
| id | integer | Gateway identifier in the PSP system. |
| note | string | The value of the Gateway note field in the gateway settings. |
| type | string | Gateway type; the name of the processor/acquirer. |
| vendor | string | Gateway type. Possible values: gateway for card integrations,beyag for alternative integrations. |
The parameters of provider_raw group
This parameter group includes information received from the provider.
The example of provider_raw group parameters
{
"provider_raw": {
"amount": 4294,
"auth_code": "654321",
"bank_code": "05",
"currency": "EUR",
"dynamic_billing_descriptor": "TEST GATEWAY BILLING DESCRIPTOR",
"message": "Payment was approved",
"ref_id": "777888",
"rrn": "999",
"status": "successful"
}
}
| Parameter | Type | Description |
|---|---|---|
| amount | bigInteger | Transaction amount in the provider's system. |
| auth_code | string | Authorization code of the provider. |
| bank_code | string | Transaction result code in the provider's system. |
| currency | string | Transaction currency in the provider's system. |
| dynamic_billing_descriptor | string | The description of the transaction result in the provider's system. |
| message | string | Transaction result message in the provider's system. |
| ref_id | string | Transaction identifier in the provider's system. |
| rrn | string | A retrieval reference number. A transaction ID issued by a card processing network. |
| status | string | Transaction status in the provider's system. |
The parameters of links group
This parameter group includes links associated with the transaction processing.
The example of links group parameters
{
"links": {
"notification_url": null,
"receipt_url": "{backoffice_url}/customer/transactions/caeb055b-de38-4b8d-abcb-cb5c80388ec9/c03548f824b64d2b3aa8bd71835de556e68448ee719bb03e99d7dd1b8b21ec91?language=en",
"redirect_url": "{gateway_url}/process/caeb055b-de38-4b8d-abcb-cb5c80388ec9",
"return_url": null
}
}
| Parameter | Type | Description |
|---|---|---|
| notification_url | string | URL where the webhook notifications are sent. |
| receipt_url | string | Link to the receipt in PDF. |
| redirect_url | string | URL of the payment page. |
| return_url | string | URL to which the customer will be redirected after completing the payment or passing 3-D Secure authentication. |
The parameters of three_d_secure_verification group
This parameter group includes links associated with the transaction processing.
The example of three_d_secure_verification group parameters
{
"three_d_secure_verification": {
"acs_url": null,
"cavv": "AJkBCHWHCAAAACcQkzEgdThBmSg=",
"cavv_algorithm": null,
"creq": null,
"eci": "05",
"fail_reason": null,
"md": null,
"message": "Authentication Successful",
"method_process_url": null,
"pa_req": null,
"pa_res_url": "{gateway_url}/process/337fdd84-afea-4dba-8363-4182ea33e80c",
"pa_status": "Y",
"status": "successful",
"ve_status": "Y",
"xid": "fc4d08fd-3939-4a3a-884a-54c111621c69"
}
}
| Parameter | Type | Description |
|---|---|---|
| acs_url | string | URL to the Access Control Server form (ACS form) in the card issuer's system to which the customer is redirected to complete 3-D Secure authentication. |
| cavv | string | Cardholder Authentication Verification Value (present only if the cardholder has been successfully authenticated). |
| cavv_algorithm | string | CAVV algorithm used for generating CAVV. |
| creq | string | 3-D Secure authentication request, encoded. |
| eci | string or integer | Electronic Commerce Indicator. Provides information regarding merchant protection level against chargebacks requests by the cardholders or their banks. |
| fail_reason | string | Unencrypted message indicating the reason for 3-D Secure authentication failure. |
| md | string | Unique transaction identifier, used to link the merchant's server and the issuing bank's server. |
| message | string | Message about 3-D Secure authentication status. |
| method_process_url | string | URL for additional check based on the browser data. |
| pa_req | string | Payer Authentication Request, encoded. |
| pa_res_url | string | URL where the issuing bank’s server sends a response to the payment authentication request. |
| pa_status | string | Status of payment authentication in the 3-D Secure protocol. |
| status | string | 3-D Secure authentication status. |
| ve_status | string | Verification Enrollment Status which indicates whether the cardholder’s account is enrolled in the 3-D Secure program. |
| xid | string | Unique 3-D Secure authentication identifier. |
The parameters of method group
This parameter group includes information on the payment method.
The example of method group parameters
{
"method": {
"credit_card": {
"bin": "427870",
"bin_8": "42787017",
"brand": "visa",
"exp_month": 4,
"exp_year": 2025,
"first_1": "4",
"holder": "John Doe",
"issuer_bank": "OPEN JOINT-STOCK COMPANY BANK",
"issuer_country": "LT",
"last_4": "0042",
"product": "L",
"stamp": "0259b6e0ca06ab0170efdfbc1b230b57d839112d6fbe6fef2a73670f553e49f2",
"sub_brand": null,
"token": null,
"token_provider": null
},
"type": "credit_card"
}
}
| Parameter | Type | Description |
|---|---|---|
| credit_card | object | Information on the card used for the transaction. The object is not sent if an alternative payment method was used for the transaction. |
| bin | string | 6-digit bank identification number. |
| bin_8 | string | 8-digit bank identification number. |
| brand | string | Brand of the credit card. |
| exp_month | integer | Expiration month of the credit card. |
| exp_year | integer | Expiration year of the credit card. |
| first_1 | string | The first 1 digit of the credit card. |
| holder | string | Cardholder's name. |
| issuer_bank | string | Bank that issued the card. |
| issuer_country | string | Country of the bank that issued the card in the ISO 3166-1 alpha-2 format. |
| last_4 | string | The last 4 digits of the card number. |
| product | string | Card brand or product. |
| stamp | string | Card hash. It is constant even if the expiration date or card holder are changed. |
| sub_brand | string | Sub-brand of the credit card. |
| token | string | Card token. |
| token_provider | string | Token's provider, for example, apple_pay. |
| type | string | Payment method type. For example, credit_card or alternative. |
| alternative_account | string | Payment method attribute specific to the APM, for example, account number. The parameter is sent only when the alternative payment method was used for the transaction. |
| alternative_type | string | Payment method attribute specific to the APM, for example, request type. The parameter is sent only when the alternative payment method was used for the transaction. |
| alternative_payment_info | string | Additional payment info specific to the APM. The parameter is sent only when the alternative payment method was used for the transaction. |
The parameters of customer group
This parameter group includes information on the customer.
The example of customer group parameters
{
"customer": {
"address": "77195 Wayne Village",
"birth_date": null,
"city": "South Robert",
"country": "US",
"device_id": null,
"email": "booker@example.com",
"first_name": "Maren",
"full_name": "Maren Lehner",
"gender": null,
"id": "66d25c97-21ce-4a0d-b697-c83e3c7a4cc3",
"ip": "143.241.100.223",
"last_name": "Lehner",
"middle_name": "",
"phone": null,
"state": "IA",
"taxpayer_id": null,
"zip": "36053"
}
}
| Parameter | Type | Description |
|---|---|---|
| address | string | The customer's address. |
| birth_date | string | The customer's birth date. |
| city | string | The customer's city. |
| country | string | The customer's country. |
| device_id | string | The identifier of the device used for the payment. |
| string | The customer's email address. | |
| first_name | string | The customer's first name. |
| full_name | string | The customer's full name (first name, last name and patronymic). |
| gender | string | The customer's gender. |
| id | string | The customer's identifier in the PSP system. |
| ip | string | The customer's IP address upon making a payment. |
| last_name | string | The customer's last name. |
| middle_name | string | The customer's patronymic. |
| phone | string | The customer's phone number. |
| state | string | The state of the customer. |
| taxpayer_id | string | Taxpayer identifier assigned to the customer. |
| zip | string | The customer's postal code. |
The parameters of recipient group
This parameter group includes information on the p2p transfer recipient.
The example of recipient group parameters
{
"recipient": {
"customer": {
"address": null,
"birth_date": null,
"city": null,
"country": null,
"device_id": null,
"email": null,
"first_name": null,
"full_name": " ",
"gender": null,
"id": null,
"ip": null,
"last_name": null,
"middle_name": "",
"phone": null,
"state": null,
"taxpayer_id": null,
"zip": null
},
"method": {
"credit_card": {
"bin": "464990",
"bin_8": "46499012",
"brand": "visa",
"exp_month": null,
"exp_year": null,
"first_1": "4",
"holder": "HOLDER NAME",
"issuer_bank": null,
"issuer_country": null,
"last_4": "8633",
"product": null,
"stamp": "aec63aefac94d99de0bbdb1298459f374fe9452ce199bdce27ef7fd03cb3c957",
"sub_brand": null,
"token": null,
"token_provider": null
},
"type": "credit_card"
}
}
}
| Parameter | Type | Description |
|---|---|---|
| customer | object | Information on the p2p transfer recipient. The parameters are the same as in the customer parameter group. |
| method | object | Information on the card used for the p2p transfer. The parameters are the same as in the method parameter group. |
The parameters of smart_routing_verification group
This parameter group includes information about the results of the transaction check by Smart Routing service.
The example of smart_routing_verification group parameters
{
"smart_routing_verification": {
"data": {
"action_rules": {
"Merchant_318879_Demo": {},
"Psp_39_Demo": {
"cashback": {
"Special offers for cashback cards": "skipped"
},
"fraudulent_cards": {
"PAN name is in fraud list": "passed"
}
},
"Shop_569_Demo_shop": {
"Force 3D": {
"Force 3D": "force_3ds"
},
"1_rule_MASTERCARD": {
"1_rule_MASTERCARD": "skipped"
},
"Max transaction amount - 10 000 USD": {
"Max transaction amount - 10 000 USD": "passed"
}
}
},
"force_3ds": true,
"matched_actions": {
"force_3ds": [
{
"account": "Shop_569_Demo_shop",
"alias": "Force 3D",
"description": "Force 3D"
}
],
"passed": [
{
"account": "Shop_569_Demo_shop",
"alias": "Max transaction amount - 10 000 USD",
"description": "Max transaction amount - 10 000 USD"
},
{
"account": "Psp_39_Demo",
"alias": "fraudulent_cards",
"description": "PAN name is in fraud list"
}
],
"skipped": [
{
"account": "Shop_569_Demo_shop",
"alias": "1_rule_MASTERCARD",
"description": "1_rule_MASTERCARD"
},
{
"account": "Psp_39_Demo",
"alias": "cashback",
"description": "Special offers for cashback cards"
}
]
},
"object": "1067",
"object_defined_via": "allowed objects",
"object_flows": [
{
"name": "Shop_5655",
"rules": [
{
"alias": "rule_1",
"description": "Allow cards from the list",
"error_code": "rule_inactive",
"error_message": "Rule is inactive",
"state": "skipped"
}
],
"skipped": false,
"system": false
},
{
"name": "name",
"rules": [
{
"alias": "rule 2",
"description": "rule 2",
"state": "not_matched",
"use_only_these_objects": true
}
],
"skipped": false,
"system": false
}
],
"object_name": "gw_1067",
"status": "passed",
"wb_lists": {
"psp_black_list": "not_matched",
"psp_white_list": "not_matched"
}
},
"status": "successful"
}
}
| Parameter | Type | Description |
|---|---|---|
| status | string | The status of the transaction check by Smart Routing service. Possible values:successful - check passed;failed - the transaction didn't pass the check. |
| data | object | Object with the detailed information of the transaction check results. |
| status | string | The transaction check status. Possible values: rejected - the transaction was rejected by the rule with the action reject or the transaction parameters are included in the black list,passed - in all other cases. |
| object | string | The ID of the gateway to which the transaction was sent for processing; null if all gateways were excluded by the check. |
| object_name | string | The name of the gateway that processed the transaction. |
| object_flows | array | An array of flows of object type against which the transaction was checked. Each object contains the following parameters:name - flow name;system - rule type (true if it's a system rule, otherwise, false);skipped - flow check status (true if the check against the flow was skipped, otherwise, false);rules - an array of rules within this flow. |
| rules | array | An array of objects where each object corresponds to a particular rule in the flow. |
| alias | string | The rule's name. |
| state | string | The result of the rule check. |
| description | string | The rule description. |
| error_message | string | The error message. |
| error_code | string | The error code. Possible values: precondition_failed - precondition isn't matched;rule_inactive - the rule is inactive;rule_unprocessable - the rule is not ready to be used, for example, it has been just created. This error happens in rare cases;allowed_objects_mismatch - the gateway selected by the rule wasn't available, for example, it was excluded by another rule;data_mismatch - aggregation rule error, if the transaction doesn't meet the aggregation requirements, it doesn't participate in the aggregation, for example, in calculating the sum of the transactions meeting a particular condition;not_enough_data - missing data for checking the transaction against the conditions. |
| object_defined_via | string | The method used to select the gateway for the transaction. Possible values: allowed objects - as a result of the Smart Routing checks, no particular gateway was selected, the transaction was sent to one of the available gateways that was selected either randomly or sequentially based on the Smart Routing account settings;rule - object was selected as a result of the rule. |
| action_rules | object | Object with the detailed information on the transaction check against the rules of action type. |
| {account_name} | object | Object with the detailed information about the rules that are active for the account. The parameter name includes the identifier of the account, on the level of which the rule was created. The name of the parameters of PSP, merchant and shop level follow the formats PSP_{psp_id}_{psp_name}, Merchant_{merchant_id}_{merchant_name}, Shop_{shop_id}_{shop_name} respectively. |
| {flow_name} | object | Object with the detailed information about the flow to which the rule belongs. |
| {rule_name} | object | The status of the transaction check against the rule. Parameter name matches the rule name. Possible values: passed - the check was performed, the transaction didn't match the rule conditions;skipped - the check against the rule wasn't performed, for example, the parameter from the rule condition has null value, or the transaction parameters are in the whitelist;allow - the check against the rule was performed, as a result the transaction was approved for further checks;skip 3DS - as a result of the check, the 3D-Secure verification isn't required for the transaction;notify - as a result of the rule; the notification was sent;review - as a result of the check the transaction was marked as suspicious and the corresponding email was sent to the anti-fraud email provided in the shop settings;reject - as a result of the check the transaction was rejected. |
| matched_actions | object | Object with the actions that were performed for the transaction. |
| {action name} | array | An array of rules that resulted in the action. Each rule in the array is an object that includes the rule name (alias), rule description (description), the corresponding account name (account) and, only for notify action, the % value, upon reaching which the notification was sent (breached_threshold). |
| wb_lists | object | Object with the white and black lists that were applied to the transaction. If the transaction parameters didn't match the ones in the lists, the value of the corresponding parameter will be not_matched. Otherwise, matched. |
The parameters of avs_cvc_verification group
This parameter group includes information on AVS/CVC verification results.
The example of avs_cvc_verification group parameters
{
"avs_cvc_verification": {
"avs_verification": {
"result_code": "1"
},
"cvc_verification": {
"result_code": "1"
}
}
}
| Parameter | Type | Description |
|---|---|---|
| avs_verification | object | Object with AVS verification results. |
| result_code | string | The code of AVS verification results. |
| cvc_verification | object | Object with CVC verification results. |
| result_code | string | The code of AVS verification results. |
The parameters of provider_response group
This parameter group includes an object with the raw response from the provider. It is returned only for the selected integrations.
The parameters of additional_data group
This parameter group includes JSON with the additional_data object from the response to the transaction.
The parameters of adjustments group
This parameter group includes information on the transaction amount adjustments.
The example of adjustments group parameters
{
"adjustments": {
"adjustment_amount": 0,
"initial_amount": 100,
"surcharge_info": {
"amount": null,
"currency": "USD",
"id": "dfc4625f-262c-4b4b-9e6d-17cb727733ba",
"initial_amount": 100,
"type": "surcharge_max"
}
}
}
| Parameter | Type | Description |
|---|---|---|
| adjustment_amount | bigInteger | Amount of the adjustment in minimal currency units. The overall charged amount equals the sum of initial_amount and adjustment_amount values. |
| initial_amount | bigInteger | Initial amount of the transaction without adjustment, in minimal currency units. |
| surcharge_info | object | Object with the information about the applied surcharge rate. |
| amount | bigInteger | Amount of surcharge rates applied to the transaction in minimal currency units. |
| currency | string | Adjustment currency in the ISO-4217 alpha-3 code format or a cryptocurrency code. For example, USD. |
| id | string | Identifier of the adjustment. |
| initial_amount | bigInteger | Initial transaction amount used for the surcharge calculation, in minimal currency units. |
| type | string | Type of the adjustment. Possible values: surcharge_max (surcharge rates). |
The parameters of commission group
This parameter group includes information on commission data and applied rates for the transaction (rounded values in minimal currency units). The object is included in the response only if the following conditions are met:
- transaction is not a test one;
- transaction has one of the following type (authorization, capture, void, payment, payout, refund, chargeback, p2p);
- transaction has a final status (successful or failed);
- and if commissions in DWH were calculated for it.
Example of the commission object
{
"commission": {
"bank_commission": 0,
"currency": "EUR",
"pay_to_merchant": 187,
"psp_commission": 15,
"rates": {
"bank_fee": 0,
"bank_max_commission": 0,
"bank_min_commission": 0,
"bank_rate": "0.00",
"id": "16c91a17-2cdf-4bb7-9496-8778c79bca32",
"psp_fee": 15,
"psp_max_commission": 0,
"psp_min_commission": 0,
"psp_rate": "0.00",
"rolling_reserve_days": 0,
"rolling_reserve_rate": "0.00"
},
"rolling_reserve_amount": null,
"transaction_commission": 15,
"transaction_fee": 15,
"transaction_rate": "0.00",
"transaction_rate_amount": 0
}
}
| Parameter | Type | Description |
|---|---|---|
| currency | string (4) | Currency of rates and commissions. |
| transaction_commission | integer | Total amount of acquirer and PSP commissions applied to the transaction in the transaction currency, in minimal currency units. Rolling Reserve is not included. |
| transaction_fee | integer | Total fixed rate applied to the transaction in minimal currency units. When calculated in basic currency units, corresponds to "Transaction fee" in the reports. |
| transaction_rate_amount | integer | Total amount of PSP and acquirer commission by percentage rates applied to the transaction, in minimal currency units. |
| transaction_rate | float (3,2) | Total percentage rate applied to the transaction. Corresponds to "Transaction rate" in the back office report. |
| rolling_reserve_amount | integer | Amount of the rolling reserve, in minimal currency units. |
| pay_to_merchant | bigInteger | Amount to be paid to the merchant (after deducting acquirer, PSP commissions, and security deposits) in minimal currency units. |
| psp_commission | integer | Total PSP commission (fixed + percentage amount) applied to the transaction, in minimal currency units. |
| bank_commission | integer | Total acquirer commission (fixed + percentage amount) applied to the transaction, in minimal currency units. |
| rates | object | Object of rates applied to the transaction (depends on the transaction type and transaction status). |
| id | uid | Identifier of the set of rates applied to the transaction = identifier of the rates applied to the gateway/currency and used to calculate the commission. |
| psp_fee | integer | Fixed PSP commission rate in minimal currency units (depends on the transaction type and transaction status). |
| psp_rate | float (3,2) | Percentage of the amount charged by PSP (depends on the transaction type and transaction status). |
| psp_min_commission | integer | Minimum fixed PSP commission in minimal currency units (depends on the transaction type and transaction status). |
| psp_max_commission | integer | Maximum fixed PSP commission in minimal currency units (depends on the transaction type and transaction status). |
| bank_fee | integer | Fixed acquirer commission rate in minimal currency units (depends on the transaction type and transaction status). |
| bank_rate | float (3,2) | Percentage of the amount charged by acquirer (depends on the transaction type and transaction status). |
| bank_min_commission | integer | Minimum fixed acquirer commission by percentage rate in minimal currency units (depends on the transaction type and transaction status). |
| bank_max_commission | integer | Maximum fixed acquirer commission in minimal currency units (depends on the transaction type and transaction status). |
| rolling_reserve_rate | float (3,2) | Percentage of the rolling reserve rate. |
| rolling_reserve_days | integer | Rolling reserve period in days. |