Reports APIs help you keep on top of your data and streamline your reporting, allowing you to concentrate on growing your business.
The reports API returns a limited number of entities. If the number of entities is above the limit in a requested time interval, a unique hash "next_page_iterator" will be returned in the response and should be used for further requests. If "next_page_iterator" is null, all data has been returned. If this field is not empty, a merchant must make a new request by adding the parameter "next_page_iterator".
POST https://reports.solidgate.com/api/v1/card-orders
Card Orders Report Request Body Parameters
Parameter | Mandatory | Type | Description | Value sample |
---|---|---|---|---|
date_from | Yes | String | Start date and time of orders (order.updated_at). Format "Y-m-d H:i:s" | 2019-07-07 11:00:00 |
date_to | Yes | String | End date and time of orders (order.updated_at). Format "Y-m-d H:i:s" | 2019-07-14 13:00:00 |
next_page_iterator | No | String | If it is necessary to perform a pagination in the request body, add the field with the value from the previous response. | 7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8= |
{
"date_from": "2017-07-07 11:00:00",
"date_to": "2017-07-14 13:00:00",
"next_page_iterator": "7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8="
}
Card Orders Report Response Body Parameters | Success
Parameter | Type | Description | Value sample |
---|---|---|---|
orders | List | List of orders | |
orders:order_id | String | Order ID | 1564478491360abc |
orders:status | String | Status of processed payment. Types of statuses are described in the respective directory | approved |
orders:type | String | Type of operation. Types of order status are described in the respective directory | recurring |
orders:amount | Integer | Order amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents | 1020 |
orders:currency | String | Order currency (3 letter code under ISO 4217) | USD |
orders:processing_amount | Integer | The payment amount when the payment service provider processed it. | 1020 |
orders:processing_currency | String | The three-letter ISO currency code of the payment when it was processed by payment service provider. In some cases, it is different from the original currency. | USD |
orders:traffic_source | String | Source of traffic. | |
orders:order_description | String | Order description in UTF-8 | Premium package |
orders:customer_account_id | String | customer account ID on merchant site | 4dad42f808 |
orders:customer_email | String | Customer email | test@testmail.com |
orders:customer_first_name | String | Customer's first name | John |
orders:customer_last_name | String | Customer last name | Snow |
orders:geo_country | String | Customer country. The code shall have the format ISO 3166-1 alpha-3 | GBR |
orders:ip_address | String | Customer IP (only the public one) | 8.8.8.8 |
orders:error_code | String | Error code. Error codes list | 3.02 |
orders:platform | String | Customer platform at the moment of payment. Available values: WEB - desktop, MOB - mobile version, APP - application | WEB |
orders:fraudulent | Boolean | The customer was detected on the merchant end to be the suspicious one | TRUE |
orders:is_secured | Boolean | The attribute shows that the payment goes through 3DS-verification | FALSE |
orders:created_at | String | Date and time of order creation | 2017-07-07 11:00:15 |
orders:updated_at | String | Date and time of order update | 2017-07-10 10:30:54 |
orders:psp_order_id | String | Psp_order identifier generated by payment gateway | 854756336423874823bdfsg6743gf5 |
orders:provider_payment_id | String | Psp_order identifier generated by the PSP (the value will be if the integration transmitted this data) | charge_64789DFS3827563HGF56 |
orders:transactions | List | List of order transactions | |
orders:transactions:id | String | Transaction ID | 245f6ehky4554 |
orders:transactions:operation | String | Type of operation | recurring |
orders:transactions:status | String | Transaction status | success |
orders:transactions:descriptor | String | Descriptor of order transaction (how it looks in the Bank statement) | FAKE_PSP |
orders:transactions:amount | Integer | Transaction amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents | 100 |
orders:transactions:currency | String | Transaction currency (3 letter code under ISO 4217) | USD |
orders:transactions:refund_reason | String | Refund reason for the transaction | Some Reason |
orders:transactions:refund_reason_code | String | Code of refund reason | 19 |
orders:transactions:created_at | String | Date and time of transaction creation | 2019-07-09 10:30:54 |
orders:transactions:updated_at | String | Date and time of transaction update | 2019-07-10 10:30:54 |
orders:transactions:finance_fee_amount | Integer | Fee amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents | 100 |
orders:transactions:finance_fee_currency | String | Fee currency (3 letter code under ISO 4217) | USD |
orders:transactions:card | Object | The object of the card information | |
orders:transactions:card:bank | String | A bankThe unique that issues the card | STATE BANK |
orders:transactions:card:bin | String | First 6 digits of the card number | 411111 |
orders:transactions:card:card_holder | String | Cardholder name | John Snow |
orders:transactions:card:brand | String | Card Brand | VISA |
orders:transactions:card:country | String | Country of bank | USA |
orders:transactions:card:number | String | Card number | 4111111111111111 |
orders:transactions:card:card_exp_year | Integer | Year of card expiration (4-digit format) | 2021 |
orders:transactions:card:card_exp_month | String | The month of card expiration (2-digit format) | 2 |
orders:transactions:card:card_type | String | Type of the payment card | DEBIT |
orders:transactions:billing_details | object | Billing Details | |
orders:transactions:billing_details:addres | string | Address of the billing | 8th Ave, Bowie Lane |
orders:transactions:billing_details:zip | string | ZIP for the billing | 10001 |
orders:transactions:billing_details:country | string | Country of the billing | USA |
orders:transactions:billing_details:city | string | City of the billing | New York |
orders:billing_details:state | string | State of the billing | FL |
metadata | Object | ||
metadata:next_page_iterator | String | Unique hash for receiving new data. If it's null - all data was successfully getting by the merchant | 7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8= |
{
"orders": [
{
"order_id": "1564478491360recurring",
"status": "refunded",
"type": "recurring",
"amount": 5500,
"currency": "USD",
"order_description": "test",
"traffic_source": "test",
"processing_amount": 5200,
"processing_currency": "USD,
"customer_account_id": "1234567",
"customer_email": "kurt.Cruickshank.toster@gmail.com",
"customer_first_name": null,
"customer_last_name": null,
"geo_country": "USA",
"ip_address": "8.8.8.8",
"error_code": null,
"platform": "WEB",
"fraudulent": true,
"is_secured": false,
"created_at": "2019-07-30 09:21:31",
"updated_at": "2019-07-31 08:14:13",
"psp_order_id":"854756336423874823bdfsg6743gf5"
"provider_payment_id ":"charge_64789DFS3827563HGF56"
"transactions": [
{
"id": "748b3f9eb69c6f6ac3be9102ba5a52cd5d414dd55cafb",
"operation": "refund",
"status": "success",
"descriptor": "FAKE_PSP",
"amount": 5200,
"currency": "USD",
"refund_reason": null,
"refund_reason_code": "0019",
"created_at": "2019-07-31 08:14:13",
"updated_at": "2019-07-31 08:14:13",
"finance_fee_amount": 15,
"finance_fee_currency": "USD",
"card": {
"bin": 344940,
"bank": "NATIONWIDE BUILDING SOCIETY",
"brand": "AMEX",
"country": "USA",
"number": "344940XXXXXX1496",
"card_holder": "cardholder name",
"card_exp_month": "03",
"card_exp_year": 2025,
"card_type": "DEBIT"
}
},
{
"id": "748b3f9eb69c6f6ac3be9102ba5a52cd5d400c1be0638",
"operation": "recurring",
"status": "success",
"descriptor": "FAKE_PSP",
"amount": 5200,
"currency": "USD",
"refund_reason": null,
"refund_reason_code": null,
"created_at": "2019-07-30 09:21:31",
"updated_at": "2019-07-30 09:21:33",
"finance_fee_amount": 10,
"finance_fee_currency": "USD",
"card": {
"bank": null,
"bin": "471688",
"card_holder": "diana goodman",
"brand": "VISA",
"country": "TUR",
"number": "471688XXXXXX3303",
"card_exp_month": "08",
"card_exp_year": 2022,
"card_type": "DEBIT"
},
"billing_details": {
"address": "11437 Woodmeadow Pkwy",
"zip": "85001",
"country": "USA",
"city": "New Delhi",
"state": "TX"
}
]
}
],
"metadata": {
"next_page_iterator": null
}
}
POST https://reports.solidgate.com/api/v1/card-orders/chargebacks
Chargeback Report Request Body Parameters
Parameter | Mandatory | Type | Description | Value sample |
---|---|---|---|---|
date_from | Yes | String | Start date and time of chargebacks or chargebacks flow creating. Format "Y-m-d H:i:s" | 2019-07-07 11:00:00 |
date_to | Yes | String | End date and time of chargebacks or chargebacks flow creating. Format "Y-m-d H:i:s" | 2019-07-14 13:00:00 |
next_page_iterator | No | String | If it is necessary to perform a pagination in the request body, add the field with the value from the previous response. | 7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8= |
{
"date_from": "2017-07-07 11:00:00",
"date_to": "2017-07-14 13:00:00",
"next_page_iterator": "7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8="
}
Chargeback Report Response Body Parameters
Parameter | Type | Description | Value sample |
---|---|---|---|
orders | List | List of orders with chargeback | |
orders:order_id | String | Order ID | 1564478491360abc |
orders:status | String | Status of processed payment. Types of statuses are described in the respective directory. | approved |
orders:type | String | Type of operation. Types of order status are described in the respective directory. | recurring |
orders:amount | Integer | Order amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents. | 1020 |
orders:currency | String | Order currency (3 letter code under ISO 4217) | USD |
orders:order_description | String | Order description in UTF-8 | Premium package |
orders:customer_account_id | String | customer account ID on merchant site | 4dad42f808 |
orders:customer_email | String | Customer email | test@testmail.com |
orders:customer_first_name | String | Customer's first name | John |
orders:customer_last_name | String | Customer last name | Snow |
orders:geo_country | String | Customer country. The code shall have the format ISO 3166-1 alpha-3 | GBR |
orders:ip_address | String | Customer IP (only the public one). | 8.8.8.8 |
orders:error_code | String | Error code. Error codes list | 3.02 |
orders:platform | String | Customer platform at the moment of payment. Available values: WEB - desktop, MOB - mobile version, APP - application | WEB |
orders:fraudulent | Boolean | The customer was detected on the merchant end to be the suspicious one | TRUE |
orders:is_secured | Boolean | The attribute shows that the payment goes through 3DS-verification. | FALSE |
orders:created_at | String | Date and time of order creation | 2017-07-07 11:00:15 |
orders:updated_at | String | Date and time of order update | 2017-07-10 10:30:54 |
orders:chargebacks | List | List of orders chargeback | |
orders:chargebacks:id | String | Chargeback ID | 148812 |
orders:chargebacks:created_at | String | The datetime on which the chargeback was created | 2019-07-12 10:50:25 |
orders:chargebacks:dispute_date | String | The date on which the chargeback was created by the Issuer | 2019-07-12 10:50:25 |
orders:chargebacks:settlement_date | String | The date on which the chargeback was financially settled | 2019-07-12 10:50:25 |
orders:chargebacks:status | String | Chargeback status | in_progress |
orders:chargebacks:type | String | Type of chargeback | 1st_chb |
orders:chargebacks:amount | Integer | Chargeback amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents. | 90 |
orders:chargebacks:currency | String | Transaction currency (3 letter code under ISO 4217) | USD |
orders:chargebacks:reason_group | String | Group of chargeback reason | Fraud |
orders:chargebacks:reason_code | String | Code of chargeback reason | 10.4 |
orders:chargebacks:reason_description | String | Description of chargeback reason | Fraud – Card-Absent Environment |
orders:chargebacks:finance_fee_amount | Integer | Fee amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents. | 100 |
orders:chargebacks:finance_fee_currency | String | Fee currency (3 letter code under ISO 4217) | USD |
orders:chargebacks:flows | Object | Object of the card information | |
orders:chargebacks:flows:id | String | ID of chargeback flow | 12345 |
orders:chargebacks:flows:amount | Integer | Chargeback flow amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents. | 50 |
orders:chargebacks:flows:dispute_amount | Integer | Chargeback flow dispute amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents. | 20 |
orders:chargebacks:flows:type | String | Type of chargeback | 1st_chb |
orders:chargebacks:flows:status | String | Chargeback status | in_progress |
orders:chargebacks:flows:date | String | Chargeback flow date | 2019-07-10 |
orders:chargebacks:flows:settlement_date | String | Chargeback flow settlement date | 2019-07-11 |
orders:chargebacks:flows:created_at | String | Chargeback flow created date and time | 2019-07-12 10:50:25 |
orders:chargebacks:flows:updated_at | String | Chargeback flow updated date and time | 2019-07-12 10:50:25 |
orders:chargebacks:flows:deadline_date | String | Chargeback deadline date | 2019-07-15 |
orders:chargebacks:flows:arn_code | String | ARN code | 24021219179008444371917 |
orders:chargebacks:flows:currency | String | Transaction currency (3 letter code under ISO 4217) | USD |
orders:chargebacks:flows:finance_fee_amount | Integer | Fee amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents. | 10 |
orders:chargebacks:flows:finance_fee_currency | String | Fee currency (3 letter code under ISO 4217) | USD |
metadata | Object | ||
metadata:next_page_iterator | String | Unique hash for receiving new data. If it's null - all data was successfully getting by the merchant. | 7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8= |
{
"orders": [
{
"order_id": "267715846",
"status": "approved",
"type": "recurring",
"amount": 690,
"currency": "USD",
"order_description": "VIP status",
"customer_account_id": "76315607",
"customer_email": "martin10_06@gmail.com",
"customer_first_name": "Alexander",
"customer_last_name": null,
"geo_country": "PER",
"ip_address": "132.191.0.111",
"error_code": null,
"platform": "WEB",
"fraudulent": false,
"is_secured": false,
"created_at": "2019-06-28 12:28:03",
"updated_at": "2019-06-28 12:28:05",
"chargebacks": [
{
"id": "148812",
"created_at": "2019-07-12 10:50:25",
"dispute_date": "2019-07-10",
"settlement_date": "2019-07-10",
"amount": 690,
"reason_code": "10.4",
"type": "1st_chb",
"status": "in_progress",
"reason_group": "Fraud",
"reason_description": "Fraud – Card-Absent Environment",
"currency": "USD",
"finance_fee_amount": null,
"finance_fee_currency": null,
"flows": [
{
"id": "414610",
"amount": 690,
"dispute_amount": null,
"type": "1st_chb",
"status": "in_progress",
"date": "2019-07-10",
"settlement_date": "2019-07-11",
"created_at": "2019-07-12 10:50:25",
"updated_at": "2019-07-12 10:50:25",
"deadline_date": "2019-07-22",
"arn_code": "24021219179008444371917",
"currency": "USD",
"finance_fee_amount": null,
"finance_fee_currency": null
}
]
}
]
}
],
"metadata": {
"next_page_iterator": null
}
}
POST https://reports.solidgate.com/api/v1/apm-orders
APM Orders Report Request Body Parameters
Parameter | Mandatory | Type | Description | Value sample |
---|---|---|---|---|
date_from | Yes | String | Start date and time of orders (order.updated_at). Format "Y-m-d H:i:s" | 2019-07-07 11:00:00 |
date_to | Yes | String | End date and time of orders (order.updated_at). Format "Y-m-d H:i:s" | 2019-07-14 13:00:00 |
next_page_iterator | No | String | If it is necessary to perform pagination in the request body, add the field with the value from the previous response. | 7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8= |
{
"date_from": "2017-07-07 11:00:00",
"date_to": "2017-07-14 13:00:00",
"next_page_iterator": "7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8="
}
APM Orders Report Response Body Parameters | Success
Parameter | Type | Description | Value sample |
---|---|---|---|
orders | List | List of orders | |
orders:order_id | String | Order ID | 360359 |
orders:amount | Integer | Order amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents | 1020 |
orders:currency | String | Order currency (3 letter code under ISO 4217) | USD |
orders:status | String | Order status | approved |
orders:method | String | The method used for payment | paypal-vault |
orders:created_at | String | When the order was created | 2020-07-02 23:39:06 |
orders:updated_at | String | The last time the order was updated | 2020-07-08 1:40:44 |
orders:customer_email | String | Email of the customer | test@gmail.com |
orders:geo_country | String | Customer country. The code shall have the format ISO 3166-1 alpha-3 | USA |
orders:ip_address | String | IP of the customer | 8.8.8.8 |
orders:transactions | String | ||
orders:transactions:status | String | Transaction status | processing |
orders:transactions:method | String | The method used for payment | paypal |
orders:transactions:amount | Integer | Amount of funds in the transaction | 249 |
orders:transactions:currency | String | Currency used for the transaction | USD |
orders:transactions:type | String | Type of transaction | recurring |
orders:transactions:psp_transaction_id | String | The PSP saves the encrypted payment data and responds with a unique ID for this transaction. The PSP uses the psp_transaction_id to locate the encrypted payment data for this transaction. This is the ID generated by the provider (in our case PayPal). Only for transactions with orders:method = 'paypal-vault'. | 31396940E92417428 |
orders:order_description | String | Order description in UTF-8 | Premium package |
orders:customer_account_id | String | Customer account ID on merchant site | 4dad42f808 |
orders:processing_amount | Integer | Amount of funds in the transaction | 249 |
orders:processing_currency | Currency | Currency used for the transaction | USD |
metadata | Object | ||
metadata:next_page_iterator | String | Unique hash for receiving new data. If it's null - all data was successfully getting by the merchant | 7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8= |
{
"orders": [
{
"order_id": "1547088796",
"amount": 599900,
"currency": "USD",
"status": "approved",
"method": "solid-cards",
"created_at": "2020-07-02 23:39:06",
"updated_at": "2020-07-08 01:40:44",
"customer_email": "test@gmail.com",
"geo_country":"USA",
"ip_address": "8.8.8.8",
"transactions": [
{
"status": "success",
"method": "solid-cards",
"amount": 599900,
"currency": "USD",
"type": "recurring",
"psp_transaction_id":"31396940E92417428"
}
],
"processing_amount": 599900,
"processing_currency": "USD"
},
{
"order_id": "1547088797",
"amount": 599900,
"currency": "USD",
"status": "approved",
"method": "solid-cards",
"created_at": "2020-07-02 23:39:06",
"updated_at": "2020-07-08 01:40:44",
"customer_email": "test@gmail.com",
"ip_address": "8.8.8.8",
"transactions": [
{
"status": "success",
"method": "solid-cards",
"amount": 599900,
"currency": "USD",
"type": "recurring",
"psp_transaction_id":"32196940E92417428"
}
],
"processing_amount": 599900,
"processing_currency": "USD"
},
{
"order_id": "1547088798",
"amount": 599900,
"currency": "USD",
"status": "approved",
"method": "solid-cards",
"created_at": "2020-07-02 23:39:06",
"updated_at": "2020-07-08 01:40:44",
"customer_email": "test@gmail.com",
"ip_address": "8.8.8.8",
"transactions": [
{
"status": "success",
"method": "solid-cards",
"amount": 599900,
"currency": "USD",
"type": "recurring",
"psp_transaction_id":"32226940E92417428"
}
],
"processing_amount": 599900,
"processing_currency": "USD"
},
{
"order_id": "1547607507",
"amount": 5399900,
"currency": "USD",
"status": "approved",
"method": "solid-cards",
"created_at": "2020-07-02 23:39:06",
"updated_at": "2020-07-08 01:40:44",
"customer_email": "test@gmail.com",
"ip_address": "8.8.8.8",
"transactions": [
{
"status": "success",
"method": "solid-cards",
"amount": 5399900,
"currency": "USD",
"type": "recurring",
"psp_transaction_id":"31396940E99877428"
}
],
"processing_amount": 5399900,
"processing_currency": "USD"
},
{
"order_id": "1548038304",
"amount": 3599900,
"currency": "USD",
"status": "approved",
"method": "solid-cards",
"created_at": "2020-07-02 23:39:06",
"updated_at": "2020-07-08 01:40:44",
"customer_email": "test@gmail.com",
"ip_address": "8.8.8.8",
"transactions": [
{
"status": "success",
"method": "solid-cards",
"amount": 3599900,
"currency": "USD",
"type": "recurring",
"psp_transaction_id":"31116940E92417428"
}
],
"processing_amount": 3599900,
"processing_currency": "USD"
},
{
"order_id": "1548212497",
"amount": 599900,
"currency": "USD",
"status": "approved",
"method": "solid-cards",
"created_at": "2020-07-02 23:39:06",
"updated_at": "2020-07-08 01:40:44",
"customer_email": "test@gmail.com",
"ip_address": "8.8.8.8",
"transactions": [
{
"status": "success",
"method": "solid-cards",
"amount": 599900,
"currency": "USD",
"type": "pay",
"psp_transaction_id":"31312940E92417428"
}
],
"processing_amount": 599900,
"processing_currency": "USD"
},
{
"order_id": "1548643149",
"amount": 4999900,
"currency": "USD",
"status": "approved",
"method": "solid-cards",
"created_at": "2020-07-02 23:39:06",
"updated_at": "2020-07-08 01:40:44",
"customer_email": "test@gmail.com",
"ip_address": "8.8.8.8",
"transactions": [
{
"status": "success",
"method": "solid-cards",
"amount": 4999900,
"currency": "USD",
"type": "recurring",
"psp_transaction_id":"31335940E92417428"
}
],
"processing_amount": 4999900,
"processing_currency": "USD"
}
],
"metadata": {
"next_page_iterator": null
}
}
POST https://reports.solidgate.com/api/v1/card-orders/fraud-alerts
Fraud Alerts Report Request Body Parameters
Parameter | Mandatory | Type | Description | Value sample |
---|---|---|---|---|
date_from | Yes | String | Start date and time of orders download. Format "Y-m-d H:i:s" | 2017-07-07 11:00:00 |
date_to | Yes | String | End date and time of orders download. Format "Y-m-d H:i:s" | 2017-07-14 13:00:00 |
next_page_iterator | No | String | If it is necessary to perform a pagination in the request body, add the field with the value from the previous response. | 7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8= |
{
"date_from": "2017-07-07 11:00:00",
"date_to": "2017-07-14 13:00:00",
"next_page_iterator": "7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8="
}
Fraud Alerts Report Response Body Parameters
Parameter | Type | Description | Value sample | |
---|---|---|---|---|
alerts | List | List of alerts | ||
alerts:order_id | String | Order ID | 777 | |
alerts:created_at | String | Date and time of order creation | 2017-07-07 11:00:15 | |
alerts:fraud_amount | Integer | Fraud order amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents. | 1020 | |
alerts:fraud_currency | String | Fraud order currency (3 letter code under ISO 4217) | USD | |
alerts:fraud_amount_usd | Integer | Fraud order amount in USD | 12367 | |
alerts:fraud_type | Integer | Type of fraudulent | 6 | |
alerts:card_scheme | String | Card Scheme | VISA | |
alerts:fraud_report_day | String | Day of the report of fraudulent | 2020-03-24 14:22:15 | |
alerts:reason_code_description | string | Description of reason code | Fraudulent Use of Account Number | |
metadata | Object | The customer was detected on the merchant end to be the suspicious one | TRUE | |
metadata:next_page_iterator | String | Unique hash for receiving new data. If it's null - all data was successfully getting by the merchant | 7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3 |
{
"alerts": [
{
"created_at": "2020-03-24 12:24:37",
"order_id": "1585052478109",
"fraud_amount": 5400,
"fraud_currency": "USD",
"fraud_amount_usd": 5400,
"fraud_type": "6",
"card_scheme": "VISA",
"fraud_report_date": "2020-03-24 14:22:15",
"reason_code_description": "Fraudulent Use of Account Number"
}
],
"metadata": {
"next_page_iterator": null
}
POST https://reports.solidgate.com/api/v1/subscriptions
Subscriptions Report Request Body Parameters
Parameter | Mandatory | Type | Description | Value sample |
---|---|---|---|---|
date_from | Yes | String | Start date and time of subscriptions creating/updating. Format "yyyy-MM-dd HH:mm:ss" | 2020-08-15 11:00:00 |
date_to | Yes | String | End date and time of subscriptions creating/updating. Format "yyyy-MM-dd HH:mm:ss" | 2019-09-20 13:00:00 |
next_page_iterator | No | String | If it is necessary to perform a pagination in the request body, add the field with the value from the previous response. | eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9+34Xw8= |
{
"date_from": "2020-08-15 11:00:00",
"date_to": "2020-09-20 13:00:00",
"next_page_iterator": "eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9"
}
Subscriptions Report Response Body Parameters
Parameter | Type | Description | Value sample |
---|---|---|---|
subscriptions | List | List of Subscriptions | |
subscription | Object | The object that contains information about the subscription | |
subscription:id | String(36) | The ID of the subscription | 64e1c283-17bf-45a7-90ea-2cb938081b2f |
subscription:status | String(36) | The status of the subscription | active |
subscription:started_at | String(36) | Date of the start of the subscription | 2020-06-10 15:42:24 |
subscription:expired_at | String(36) | Date of the expiration of the subscription | 2020-09-10 15:42:24 |
subscription:next_charge_at | String(36) | Date when the next payment will be done | 2020-11-26 11:43:52 |
subscription:cancelled_at | String(36) | Date of the subscription’s cancellation | 2020-06-26 06:43:58 |
subscription:trial | Boolean | Trial parameters of the subscription | true |
subscription:cancel_code | String | Cancel code list | "8.01" |
subscription:cancel_message | String | The error message associated with the corresponding ‘cancel code’ | "Card brand is not supported" |
subscription:payment_type | String | Payment type | card / paypal-vault |
subscription:customer | Object | The object that contains the information about the customer | |
subscription:customer:customer_account_id | String(100) | Customer ID in the merchant's system | 1607428830474 |
subscription:customer:customer_email | String(100) | Customer email | test@gmail.com |
product | Object | The object that contains the information about the product of the subscription | |
product:id | String(36) | The ID of the product | 68a10c82-7cd8-4700-be5c-b8931bd4a4e2 |
product:name | String(100) | Name of the product | For Testing |
product:amount | Integer | Amount of currency paid for the product | 999 |
product:currency | String | The currency of the subscription | USD |
product:trial | Boolean | Trial parameter of the product | true |
product:payment_action | String(100) | Payment type that was used to pay for the product | auth_void / charge_refund / pay |
product:trial_period | Integer | The trial period (in minutes) of the product | 7200 |
invoices | Object | Object with the information about invoices | |
invoices:invoice_id | Map | Object with the information about invoice | |
invoices:invoice_id:id | String(100) | The ID of the invoice | 9b174ec5-8a3a-4896-b099-5a8a0db04a17 |
invoices:invoice_id:amount | Integer | Amount of currency in the invoice | 999 |
invoices:invoice_id:status | String(100) | Status of the invoice | success |
invoices:invoice_id:created_at | String(100) | Date of the creation of the invoice | 2020-10-01 08:32:24 |
invoices:invoice_id:updated_at | String(100) | Date of the invoice update | 2020-10-01 08:32:24 |
invoices:invoice_id:billing_period_started_at | String(100) | Start date of the billing period | 2020-10-28 15:38:36 |
invoices:invoice_id:billing_period_ended_at | String(100) | Billing period end date | 2020-10-28 15:39:36 |
invoices:invoice_id:subscription_term_number | Integer | Subscription term number | 0 |
invoices:invoice_id:orders: | Map | Object with the information about the order | |
invoices:invoice_id:orders:id | String(100) | ID of the order | 1601541121984init |
invoices:invoice_id:orders:status | String(100) | Current status of the order | approved |
invoices:invoice_id:orders:amount | Integer | Amount of currency in the order | 999 |
invoices:invoice_id:orders:created_at | String(100) | Date of creation of the order | 2020-10-01 08:32:24 |
invoices:invoice_id:orders:processed_at | String(100) | Order processing date | 2020-10-01 08:32:24 |
invoices:invoice_id:orders:failed_reason | String(36) | Error code | 3.02 |
invoices:invoice_id:orders:operation | String(100) | Type of operation | pay |
invoices:invoice_id:orders:retry_attempt | Integer | Retry attempt number | 1 |
metadata | Object | ||
metadata:next_page_iterator | String | The unique hash for receiving new data. If it's null - all data was successfully getting by the merchant | eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9 |
{
"subscriptions": {
"75086028-8cfa-4c80-ac42-0a122aa40e64": {
"id": "75086028-8cfa-4c80-ac42-0a122aa40e64",
"status": "active",
"started_at": "2020-12-08 12:01:03",
"expired_at": "2020-12-08 12:02:03",
"next_charge_at": "2020-12-08 12:02:03",
"trial": false,
"payment_type": "paypal-vault",
"customer": {
"customer_account_id": "1607428830474",
"customer_email": "test@gmail.com"
},
"product": {
"id": "ce43b415-5522-4373-b026-a365462f9790",
"name": "autotest_paypal-vault",
"amount": 100,
"currency": "USD",
"trial": true,
"payment_action": "auth_void",
"trial_period": 1
},
"invoices": {
"4022a203-ace8-415f-9ae7-730014fceb25": {
"id": "4022a203-ace8-415f-9ae7-730014fceb25",
"amount": 100,
"status": "success",
"created_at": "2020-12-08 12:01:03",
"updated_at": "2020-12-08 12:01:03",
"billing_period_started_at": "2020-12-08 12:01:03",
"billing_period_ended_at": "2020-12-08 12:02:03",
"subscription_term_number": 0,
"orders": {
"1607428830466widget": {
"id": "1607428830466widget",
"status": "refunded",
"amount": 100,
"created_at": "2020-12-08 12:01:03",
"processed_at": "2020-12-08 12:01:02",
"operation": "paypal-vault"
}
}
}
}
},
"b5f32e30-b5d0-4135-af61-cd95bee9a23a": {
"id": "b5f32e30-b5d0-4135-af61-cd95bee9a23a",
"status": "active",
"started_at": "2020-12-08 12:00:14",
"expired_at": "2020-12-08 12:02:55",
"cancelled_at": "2020-12-08 12:02:55",
"next_charge_at": "2020-12-08 12:02:55",
"trial": false,
"cancel_code": "8.06",
"cancel_message": "Cancellation by support",
"payment_type": "paypal-vault",
"customer": {
"customer_account_id": "1607428713215",
"customer_email": "test12345@gmail.com"
},
"product": {
"id": "a51ba9fd-3be1-4ef9-b00f-bb85157597f5",
"name": "autotest_paypal-vault 2",
"amount": 888,
"currency": "USD",
"trial": true,
"payment_action": "charge_refund",
"trial_period": 1
},
"invoices": {
"311b34ca-b9af-40b6-8e75-89b5d5ec0dba": {
"id": "311b34ca-b9af-40b6-8e75-89b5d5ec0dba",
"amount": 888,
"status": "success",
"created_at": "2020-12-08 12:01:51",
"updated_at": "2020-12-08 12:01:55",
"billing_period_started_at": "2020-12-08 12:01:55",
"billing_period_ended_at": "2020-12-08 12:02:55",
"subscription_term_number": 1,
"orders": {
"86de0c5c-76d4-4f7c-9b93-e3dd73d89a79": {
"id": "86de0c5c-76d4-4f7c-9b93-e3dd73d89a79",
"status": "approved",
"amount": 888,
"created_at": "2020-12-08 12:01:51",
"processed_at": "2020-12-08 12:01:55",
"operation": "recurring"
}
}
},
"29a7ace4-01f9-4399-b859-9256f3ad193b": {
"id": "29a7ace4-01f9-4399-b859-9256f3ad193b",
"amount": 444,
"status": "success",
"created_at": "2020-12-08 12:00:14",
"updated_at": "2020-12-08 12:00:14",
"billing_period_started_at": "2020-12-08 12:00:14",
"billing_period_ended_at": "2020-12-08 12:01:14",
"subscription_term_number": 0,
"orders": {
"1607428713208widget": {
"id": "1607428713208widget",
"status": "refunded",
"amount": 444,
"created_at": "2020-12-08 12:00:14",
"processed_at": "2020-12-08 12:00:13",
"operation": "paypal-vault"
}
}
}
}
}
},
"metadata": {
"next_page_iterator": null
}
}
POST https://reports.solidgate.com/api/v1/apm-orders/paypal-disputes
PayPal Disputes Report Request Body Parameters
Parameter | Mandatory | Type | Description | Value sample |
---|---|---|---|---|
date_from | Yes | String | Start date and time of disputes (dispute.created_at). Format "Y-m-d H:i:s" | 2019-07-07 11:00:00 |
date_to | Yes | String | End date and time of disputes (dispute.created_at). Format "Y-m-d H:i:s" | 2019-07-14 13:00:00 |
next_page_iterator | No | String | If it is necessary to perform pagination in the request body, add the field with the value from the previous response. | 7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8= |
{
"date_from": "2017-07-07 11:00:00",
"date_to": "2017-07-14 13:00:00",
"next_page_iterator": "7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8="
}
PayPal Disputes Report Response Body Parameters | PayPal
Parameter | Type | Description | Value sample |
---|---|---|---|
disputes | List | List of disputes | |
disputes:dispute_id | String | Dispute ID | PP-D-85112454 |
disputes:order_id | String | Order ID | fdsyf9s8d69ds6gds96 |
disputes:dispute_amount | Integer | Dispute amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents | 1020 |
disputes:dispute_currency | String | Dispute currency (3 letter code under ISO 4217) | USD |
disputes:reason | String | Reason for the dispute | MERCHANDISE_OR_SERVICE_NOT_RECEIVED |
disputes:status | String | Status of the dispute | WAITING_FOR_BUYER_RESPONSE |
disputes:dispute_life_cycle_stage | String | Stage of dispute life-cycle | INQUIRY |
disputes:dispute_channel | String | The channel by which dispute was received | INTERNAL |
disputes:dispute_create_time | String | When the dispute was created | 2020-07-02 23:39:06 |
disputes:dispute_update_time | String | The last time the dispute was updated | 2020-07-08 1:40:44 |
disputes:customer_email | String | Email of the customer | test@gmail.com |
disputes:seller_response_due_date | String | When seller responded to the dispute | 2020-09-14 16:29:12 |
disputes:created_at | String | Time of the dispute creation | 2020-08-23 12:05:28 |
metadata | Object | ||
metadata:next_page_iterator | String | Unique hash for receiving new data. If it's null - all data was successfully getting by the merchant | 7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8= |
"disputes": [
{
"dispute_id": "PP-D-85112454",
"subscription_service_id": "a1239de9-q3gc-2156-4678-12rf178sdd1a",
"order_id": "fdsyf9s8d69ds6gds96",
"customer_account_id": "989742",
"customer_email": "fairmail@yahoo.com",
"subscription_product_id": "1a492e4b-29d8-324a-f4fad-8bfa6e44r4w6",
"dispute_amount": 100,
"dispute_currency": "USD",
"reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED",
"status": "WAITING_FOR_BUYER_RESPONSE",
"dispute_life_cycle_stage": "INQUIRY",
"dispute_channel": "INTERNAL",
"seller_response_due_date": "2020-09-24 06:29:38",
"dispute_create_time": "2020-08-15 08:05:01",
"dispute_update_time": "2020-08-15 12:00:13",
"created_at": "2020-08-23 12:05:28"
}
]
The report can be generated in two ways:
The report comes in .csv format.
POST https://reports.solidgate.com/api/v1/finance/financial_entries
Financial Entries Report Request Body Parameters
Parameter | Mandatory | Type | Description | Value sample |
---|---|---|---|---|
date_from | Yes | String | Start date and time of financial entries creating. Format "Y-m-d H:i:s" | 2022-07-07 11:00:00 |
date_to | Yes | String | End date and time of of financial entries creating. Format "Y-m-d H:i:s" | 2022-07-14 13:00:00 |
{
"date_from": "2022-07-07 11:00:00",
"date_to": "2022-07-14 13:00:00"
}
POST https://reports.solidgate.com/api/v1/finance/financial_entries/settlement
Financial Entries Report Request Body Parameters
Parameter | Mandatory | Type | Description | Value sample |
---|---|---|---|---|
settlement_id | Yes | String | ID of the settlement | 2A1N0V1 |
{
"settlement_id": "2A1N0V1"
}
Financial Entries Report Response Body Parameters
Parameter | Type | Value sample |
---|---|---|
report_url | String | https://reports.solidgate.com/api/v1/finance/financial_entries/report/fin_220808_143924_test/download |
{
"report_url": "https://reports.solidgate.com/api/v1/finance/financial_entries/report/fin_220808_143924_test/download"
}
The report can be downloaded from the link provided in report_url field. You must use the correct specified credentials (merchantID + privateKey) because the request is validated by report_id and merchant_id.
GET https://reports.solidgate.com/api/v1/finance/financial_entries/report/{report_id}/download
Response code | Description |
---|---|
101 | Authentication failed. You need to double-check access to Solidgate API. |
204 | Report is not ready. |
302 | Redirect to one-time S3 download report link. Actions completed successfully. |
404 | Report not found. |
410 | Report unavailable (expired). It is checked that the report was collected >= 30 days ago. |
Financial Entries CSV Report Parameters
Parameter | Type | Description | Value sample |
id | String | Financial record ID. | ft_1mc2209090000_fKJScPc |
order_id | Order ID generated by the merchant. | mvbcdj1335d | |
external_psp_order_id | Order ID generated by Solidgate. | 2343253452323412sd12ds | |
created_at | The timestamp of when the record was created by Solidgate's financial system. Format: YYYY-MM-DD HH:MM:SS | 2021-07-23 17:39:50 | |
transaction_datetime_provider | The date on which the transaction or fee occurred. Dates in the timezone of the provider. | 2021-07-23 17:39:50 | |
transaction_datetime_utc | The date on which the transaction or fee occurred. Dates in UTC. | 2021-07-23 17:39:50 | |
accounting_date | Determines which settlement or invoice the record will be included in. Only populated for provider = 'Solidgate'. Format: YYYY-MM-DD | 2021-07-23 | |
amount | The original amount of the financial record. Expressed in minor currency units (as an integer). For instance, 1020 means 10 USD and 20 cents. | 1020 | |
currency | The currency in which the financial record is initially defined (3 letter code under ISO 4217). | EUR | |
currency_minor_units | Minor units of the currency. | 100 | |
payout_amount | The payout amount. Expressed in minor currency units (as an integer). For instance, 1020 means 10 USD and 20 cents. | 1020 | |
payout_currency | The payout currency (3 letter code under ISO 4217). | EUR | |
payout_currency_minor_units | Minor units of the payout currency. | 100 | |
record_type_key | Type of financial record. For example: SALE, REFUND, DISCOUNT FEE, CHARGEBACK FEE. | SALE | |
provider | Name of the Provider that processed the transaction. | Solidgate | |
payment_method | Payment method. | card | |
card_brand | Card Brand. | VISA | |
geo_country | Customer country. The code shall have the format ISO 3166-1 alpha-3. | USA | |
issuing_country | Сountry of the issuing bank. | USA |