Analytics#
Retrieve and filter your complete transaction history for reconciliation, reporting, and operational monitoring. The Analytics API returns paginated results with detailed transaction data across all payment methods.Use v2 of the Analytics API. v1 is deprecated and will be removed in a future release.
Endpoint#
GET https://api.kushkipagos.com/analytics/v2/transactions-list
Authentication#
All requests require your Private Key from the Kushki Console, passed as a header:| Header | Value |
|---|
Private-Merchant-Id | Your private API key |
Content-Type | application/json |
Query parameters#
Required#
| Parameter | Type | Description |
|---|
from | string | Start of the date range — ISO format YYYY-MM-DDTHH:MM:SS |
to | string | End of the date range — ISO format YYYY-MM-DDTHH:MM:SS |
Filters#
| Parameter | Type | Allowed values |
|---|
payment_method | string | card, transfer, cash |
transaction_status | string | APPROVAL, DECLINED, INITIALIZED |
transaction_type | string | SALE, CAPTURE, VOID, DEFERRED, PREAUTHORIZATION, REFUND |
card_type | string | debit, credit |
external_reference_id | string | Your own order or reference ID (v2 only) |
| Parameter | Type | Default | Description |
|---|
offset | integer | 0 | Number of records to skip |
limit | integer | 100 | Number of records to return per page |
Example request#
Response#
{
"total": 342,
"data": [
{
"ticket_number": "123456789",
"transaction_id": "1234567890abcdef",
"transaction_reference": "abc123",
"transaction_status": "APPROVAL",
"payment_method": "card",
"transaction_type": "SALE",
"approved_transaction_amount": 25.00,
"currency_code": "USD",
"created": "2024-01-15T14:32:00",
"complete": "2024-01-15T14:32:05",
"card_holder_name": "Jane Doe",
"masked_credit_card": "XXXXXXXXXXXX1234",
"payment_brand": "VISA",
"card_type": "credit",
"issuing_bank": "Banco Pichincha",
"approval_code": "123456",
"response_code": "000",
"external_reference_id": "order-9876",
"contact_details": {
"email": "jane@example.com"
},
"metadata": {}
}
]
}
Key response fields#
| Field | Description |
|---|
total | Total number of transactions matching the filters |
ticket_number | Kushki-assigned transaction ticket number |
transaction_id | Unique transaction identifier |
transaction_reference | Merchant-facing reference |
transaction_status | APPROVAL, DECLINED, or INITIALIZED |
payment_method | card, transfer, or cash |
transaction_type | SALE, CAPTURE, VOID, DEFERRED, PREAUTHORIZATION, or REFUND |
approved_transaction_amount | Amount approved in USD |
currency_code | Always USD for Ecuador |
created | Transaction creation timestamp |
complete | Transaction completion timestamp |
masked_credit_card | Masked card number (last 4 digits visible) |
payment_brand | Card network — VISA, MASTERCARD, etc. |
card_type | debit or credit |
issuing_bank | Name of the card-issuing bank |
approval_code | Acquirer approval code |
response_code | Processor response code |
external_reference_id | Your custom order or reference ID (if sent at charge time) |
Use offset and limit to page through large result sets. Check total in the response to determine how many pages to request.Page 1: offset=0, limit=100 → records 1–100
Page 2: offset=100, limit=100 → records 101–200
Page 3: offset=200, limit=100 → records 201–300
Deprecated: v1#
GET /analytics/v1/transactions-list is deprecated. Migrate to v2.v2 adds the external_reference_id filter and removes bin_card and last_four_digits as query parameters. All new integrations should use v2.
Requirements#
A Kushki account with the Analytics feature enabled
Got a suggestion on this documentation? Contact us.
