Reports

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".

Card Orders

POST https://reports.solidgate.com/api/v1/card-orders

Card Orders Report Request Body Parameters

ParameterMandatoryTypeDescriptionValue sample
date_fromYesStringStart date and time of orders and transactions creating. Format "Y-m-d H:i:s"2019-07-07 11:00:00
date_toYesStringEnd date and time of orders and transactions creating. Format "Y-m-d H:i:s"2019-07-14 13:00:00
next_page_iteratorNoStringIf it is necessary to perform a pagination in the request body, add the field with the value from the previous response.7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8=

Card Orders Report Request Sample

{
  "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

ParameterTypeDescriptionValue sample
ordersListList of orders 
orders:order_idStringOrder ID1564478491360abc
orders:statusStringStatus of processed payment. Types of statuses are described in the respective directoryapproved
orders:typeStringType of operation. Types of order status are described in the respective directoryrecurring
orders:amountIntegerOrder amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents1020
orders:currencyStringOrder currency (3 letter code under ISO 4217)USD
orders:processing_amountIntegerThe payment amount when the payment service provider processed it.1020
orders:processing_currencyStringThe 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_sourceStringSource of traffic.facebook
orders:order_descriptionStringOrder description in UTF-8Premium package
orders:customer_account_idStringcustomer account ID on merchant site4dad42f808
orders:customer_emailStringCustomer emailtest@testmail.com
orders:customer_first_nameStringCustomer's first nameJohn
orders:customer_last_nameStringCustomer last nameSnow
orders:geo_countryStringCustomer country. The code shall have the format ISO 3166-1 alpha-3GBR
orders:ip_addressStringCustomer IP (only the public one)8.8.8.8
orders:error_codeStringError code. Error codes list3.02
orders:platformStringCustomer platform at the moment of payment. Available values: WEB - desktop, MOB - mobile version, APP - applicationWEB
orders:fraudulentBooleanThe customer was detected on the merchant end to be the suspicious oneTRUE
orders:is_securedBooleanThe attribute shows that the payment goes through 3DS-verificationFALSE
orders:created_atStringDate and time of order creation2017-07-07 11:00:15
orders:updated_atStringDate and time of order update2017-07-10 10:30:54
orders:psp_order_idStringPsp_order identifier generated by payment gateway 854756336423874823bdfsg6743gf5
orders:provider_payment_idStringPsp_order identifier generated by the PSP (the value will be if the integration transmitted this data)charge_64789DFS3827563HGF56
orders:transactionsListList of order transactions 
orders:transactions:idStringTransaction ID245f6ehky4554
orders:transactions:operationStringType of operationrecurring
orders:transactions:statusStringTransaction statussuccess
orders:transactions:descriptorStringDescriptor of order transaction (how it looks in the Bank statement)FAKE_PSP
orders:transactions:amountIntegerTransaction amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents100
orders:transactions:currencyStringTransaction currency (3 letter code under ISO 4217)USD
orders:transactions:refund_reasonStringRefund reason for the transactionSome Reason
orders:transactions:refund_reason_codeStringCode of refund reason19
orders:transactions:created_atStringDate and time of transaction creation2019-07-09 10:30:54
orders:transactions:updated_atStringDate and time of transaction update2019-07-10 10:30:54
orders:transactions:finance_fee_amountIntegerFee amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents100
orders:transactions:finance_fee_currencyStringFee currency (3 letter code under ISO 4217)USD
orders:transactions:cardObjectThe object of the card information 
orders:transactions:card:bankStringA bankThe unique that issues the cardSTATE BANK
orders:transactions:card:binStringFirst 6 digits of the card number411111
orders:transactions:card:card_holderStringCardholder nameJohn Snow
orders:transactions:card:brandStringCard BrandVISA
orders:transactions:card:countryStringCountry of bankUSA
orders:transactions:card:numberStringCard number4111111111111111
orders:transactions:card:card_exp_yearIntegerYear of card expiration (4-digit format)2021
orders:transactions:card:card_exp_monthStringThe month of card expiration (2-digit format)2
orders:transactions:card:card_typeStringType of the payment cardDEBIT
orders:transactions:billing_detailsobjectBilling Details 
orders:transactions:billing_details:addresstringAddress of the billing8th Ave, Bowie Lane
orders:transactions:billing_details:zipstringZIP for the billing10001
orders:transactions:billing_details:countrystringCountry of the billingUSA
orders:transactions:billing_details:citystringCity of the billingNew York
orders:billing_details:statestringState of the billingFL
metadataObject  
metadata:next_page_iteratorStringUnique hash for receiving new data. If it's null - all data was successfully getting by the merchant7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8=

Card Orders Report Response Sample | Success

{
  "orders": [
    {
      "order_id": "1564478491360recurring",
      "status": "refunded",
      "type": "recurring",
      "amount": 5200,
      "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": {
            "bank": null,
            "bin": null,
            "card_holder": null,
            "brand": null,
            "country": null,
            "number": null,
            "card_exp_month": null,
            "card_exp_year": null,
            "card_type": null
          }
        },
        {
          "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
  }
}

Chargebacks

POST https://reports.solidgate.com/api/v1/card-orders/chargebacks

   Chargeback Report Request Body Parameters

ParameterMandatoryTypeDescriptionValue sample
date_fromYesStringStart date and time of chargebacks or chargebacks flow creating. Format "Y-m-d H:i:s"2019-07-07 11:00:00
date_toYesStringEnd date and time of chargebacks or chargebacks flow creating. Format "Y-m-d H:i:s"2019-07-14 13:00:00
next_page_iteratorNoStringIf it is necessary to perform a pagination in the request body, add the field with the value from the previous response.7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8=

Chargeback Report Request Sample

{
  "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

ParameterTypeDescriptionValue sample
ordersListList of orders with chargeback 
orders:order_idStringOrder ID1564478491360abc
orders:statusStringStatus of processed payment. Types of statuses are described in the respective directory.approved
orders:typeStringType of operation. Types of order status are described in the respective directory.recurring
orders:amountIntegerOrder amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents.1020
orders:currencyStringOrder currency (3 letter code under ISO 4217)USD
orders:order_descriptionStringOrder description in UTF-8Premium package
orders:customer_account_idStringcustomer account ID on merchant site4dad42f808
orders:customer_emailStringCustomer emailtest@testmail.com
orders:customer_first_nameStringCustomer's first nameJohn
orders:customer_last_nameStringCustomer last nameSnow
orders:geo_countryStringCustomer country. The code shall have the format ISO 3166-1 alpha-3GBR
orders:ip_addressStringCustomer IP (only the public one).8.8.8.8
orders:error_codeStringError code. Error codes list.3.02
orders:platformStringCustomer platform at the moment of payment. Available values: WEB - desktop, MOB - mobile version, APP - applicationWEB
orders:fraudulentBooleanThe customer was detected on the merchant end to be the suspicious oneTRUE
orders:is_securedBooleanThe attribute shows that the payment goes through 3DS-verification.FALSE
orders:created_atStringDate and time of order creation2017-07-07 11:00:15
orders:updated_atStringDate and time of order update2017-07-10 10:30:54
orders:chargebacksListList of orders chargeback 
orders:chargebacks:idStringChargeback ID148812
orders:chargebacks:created_atStringDate and time of chargeback creation2019-07-12 10:50:25
orders:chargebacks:dispute_dateStringChargeback dispute date2019-07-12 10:50:25
orders:chargebacks:settlement_dateStringChargeback settlement date2019-07-12 10:50:25
orders:chargebacks:statusStringChargeback statusin_progress
orders:chargebacks:typeStringType of chargeback1st_chb
orders:chargebacks:amountIntegerChargeback amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents.90
orders:chargebacks:currencyStringTransaction currency (3 letter code under ISO 4217)USD
orders:chargebacks:reason_groupStringGroup of chargeback reasonFraud
orders:chargebacks:reason_codeStringCode of chargeback reason10.4
orders:chargebacks:reason_descriptionStringDescription of chargeback reasonFraud – Card-Absent Environment
orders:chargebacks:finance_fee_amountIntegerFee amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents.100
orders:chargebacks:finance_fee_currencyStringFee currency (3 letter code under ISO 4217)USD
orders:chargebacks:flowsObjectObject of the card information 
orders:chargebacks:flows:idStringID of chargeback flow12345
orders:chargebacks:flows:amountIntegerChargeback flow amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents.50
orders:chargebacks:flows:dispute_amountIntegerChargeback flow dispute amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents.20
orders:chargebacks:flows:typeStringType of chargeback1st_chb
orders:chargebacks:flows:statusStringChargeback statusin_progress
orders:chargebacks:flows:dateStringChargeback flow date2019-07-10
orders:chargebacks:flows:settlement_dateStringChargeback flow settlement date2019-07-11
orders:chargebacks:flows:created_atStringChargeback flow created date and time2019-07-12 10:50:25
orders:chargebacks:flows:updated_atStringChargeback flow updated date and time2019-07-12 10:50:25
orders:chargebacks:flows:deadline_dateStringChargeback deadline date2019-07-15
orders:chargebacks:flows:arn_codeStringARN code24021219179008444371917
orders:chargebacks:flows:currencyStringTransaction currency (3 letter code under ISO 4217)USD
orders:chargebacks:flows:finance_fee_amountIntegerFee amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents.10
orders:chargebacks:flows:finance_fee_currencyStringFee currency (3 letter code under ISO 4217)USD
metadataObject  
metadata:next_page_iteratorStringUnique hash for receiving new data. If it's null - all data was successfully getting by the merchant.7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8=

Chargeback Report Response Sample | Success

{
  "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
  }
}

APM Orders

POST https://reports.solidgate.com/api/v1/apm-orders

APM Orders Report Request Body Parameters

ParameterMandatoryTypeDescriptionValue sample
date_fromYesStringStart date and time of orders and transactions creating. Format "Y-m-d H:i:s"2019-07-07 11:00:00
date_toYesStringEnd date and time of orders and transactions creating. Format "Y-m-d H:i:s"2019-07-14 13:00:00
next_page_iteratorNoStringIf it is necessary to perform pagination in the request body, add the field with the value from the previous response.7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8=

APM Orders Report Request Sample

{
  "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

ParameterTypeDescriptionValue sample
ordersListList of orders 
orders:order_idStringOrder ID360359
orders:amountIntegerOrder amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents1020
orders:currencyStringOrder currency (3 letter code under ISO 4217)USD
orders:statusStringStatus of processed payment. Types of statuses are described in the respective directoryapproved
orders:methodStringThe method used for paymentpaypal
orders:created_atStringWhen the order was created2020-07-02 23:39:06
orders:updated_atStringThe last time the order was updated2020-07-08 1:40:44
orders:customer_emailStringEmail of the customertest@gmail.com
orders:ip_addressStringIP of the customer70.65.246.237
orders:transactionsString  
orders:transactions:statusStringStatus of the transactionprocessing
orders:transactions:methodStringThe method used for paymentpaypal
orders:transactions:amountIntegerAmount of funds in the transaction249
orders:transactions:currencyStringCurrency used for the transactionUSD
orders:transactions:typeStringType of the transactionsrecurring
orders:order_descriptionStringOrder description in UTF-8Premium package
orders:customer_account_idStringCustomer account ID on merchant site4dad42f808
orders:processing_amountIntegerAmount of funds in the transaction249
orders:processing_currencyCurrencyCurrency used for the transactionUSD
metadataObject  
metadata:next_page_iteratorStringUnique hash for receiving new data. If it's null - all data was successfully getting by the merchant7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8=

APM Orders Report Response Sample | Success

{
  "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",
      "ip_address": "8.8.8.8",
      "transactions": [
        {
          "status": "success",
          "method": "solid-cards",
          "amount": 599900,
          "currency": "USD",
          "type": "recurring"
        }
      ],
      "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"
        }
      ],
      "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"
        }
      ],
      "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"
        }
      ],
      "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"
        }
      ],
      "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"
        }
      ],
      "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"
        }
      ],
      "processing_amount": 4999900,
      "processing_currency": "USD"
    }
  ],
  "metadata": {
    "next_page_iterator": null
  }
}

Fraud Alerts

POST https://reports.solidgate.com/api/v1/card-orders/fraud-alerts

 Fraud Alerts Report Request Body Parameters

ParameterMandatoryTypeDescriptionValue sample
date_fromYesStringStart date and time of orders download. Format "Y-m-d H:i:s"2017-07-07 11:00:00
date_toYesStringEnd date and time of orders download. Format "Y-m-d H:i:s"2017-07-14 13:00:00
next_page_iteratorNoStringIf it is necessary to perform a pagination in the request body, add the field with the value from the previous response.7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8=

Fraud Alerts Report Request Sample

{
  "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

ParameterTypeDescriptionValue sample 
alertsListList of alerts  
alerts:order_idStringOrder ID777 
alerts:created_atStringDate and time of order creation2017-07-07 11:00:15 
alerts:fraud_amountIntegerFraud order amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents.1020 
alerts:fraud_currencyStringFraud order currency (3 letter code under ISO 4217)USD 
alerts:fraud_amount_usdIntegerFraud order amount in USD12367 
alerts:fraud_typeIntegerType of fraudulent6 
alerts:card_schemeStringCard SchemeVISA 
alerts:fraud_report_dayStringDay of the report of fraudulent2020-03-24 14:22:15 
alerts:reason_code_descriptionstringDescription of reason codeFraudulent Use of Account Number 
metadataObjectThe customer was detected on the merchant end to be the suspicious oneTRUE 
metadata:next_page_iteratorStringUnique hash for receiving new data. If it's null - all data was successfully getting by the merchant7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3 

Fraud Alerts Report Response Sample

{
  "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
  }

Subscriptions

POST https://reports.solidgate.com/api/v1/subscriptions

 Subscriptions Report Request Body Parameters

ParameterMandatoryTypeDescriptionValue sample
date_fromYesStringStart date and time of subscriptions creating/updating. Format "yyyy-MM-dd HH:mm:ss"2020-08-15 11:00:00
date_toYesStringEnd date and time of subscriptions creating/updating. Format "yyyy-MM-dd HH:mm:ss"2019-09-20 13:00:00
next_page_iteratorNoStringIf it is necessary to perform a pagination in the request body, add the field with the value from the previous response.eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9+34Xw8=

Subscriptions Report Request Sample

{
"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

ParameterTypeDescriptionValue sample
subscriptionsListList of Subscriptions 
subscriptionObject
 
The object that contains information about the subscription 
subscription:idString(36)The ID of the subscription64e1c283-17bf-45a7-90ea-2cb938081b2f
subscription:statusString(36)The status of the subscriptionactive
subscription:started_atString(36)Date of the start of the subscription2020-06-10 15:42:24
subscription:expired_atString(36)Date of the expiration of the subscription2020-09-10 15:42:24
subscription:next_charge_atString(36)Date when the next payment will be done2020-11-26 11:43:52
subscription:cancelled_atString(36)Date of the subscription’s cancellation2020-06-26 06:43:58
subscription:trialBooleanTrial parameters of the subscriptiontrue
subscription:cancel_codeStringCancel code list"8.01"
subscription:cancel_messageStringThe error message associated with the corresponding ‘cancel code’"Card brand is not supported"
subscription:payment_typeStringPayment typecard / paypal-vault
subscription:customerObjectThe object that contains the information about the customer 
subscription:customer:customer_account_idString(100)Customer ID in the merchant's system1607428830474
subscription:customer:customer_emailString(100)Customer emailtest@gmail.com
productObjectThe object that contains the information about the product of the subscription 
product:idString(36)The ID of the product68a10c82-7cd8-4700-be5c-b8931bd4a4e2
product:nameString(100)Name of the productFor Testing
product:amountIntegerAmount of currency paid for the product999
product:currencyStringThe currency of the subscriptionUSD
product:trialBooleanTrial parameter of the producttrue
product:payment_actionString(100)Payment type that was used to pay for the productauth_void / charge_refund / pay
product:trial_periodIntegerThe trial period (in minutes) of the product7200
invoicesObjectObject with the information about invoices 
invoices:invoice_idMapObject with the information about invoice 
invoices:invoice_id:idString(100)The ID of the invoice9b174ec5-8a3a-4896-b099-5a8a0db04a17
invoices:invoice_id:amountIntegerAmount of currency in the invoice999
invoices:invoice_id:statusString(100)Status of the invoicesuccess
invoices:invoice_id:created_atString(100)Date of the creation of the invoice2020-10-01 08:32:24
invoices:invoice_id:updated_atString(100)Date of the invoice update2020-10-01 08:32:24
invoices:invoice_id:billing_period_started_atString(100)Start date of the billing period2020-10-28 15:38:36
invoices:invoice_id:billing_period_ended_atString(100)Billing period end date2020-10-28 15:39:36
invoices:invoice_id:subscription_term_numberIntegerSubscription term number0
invoices:invoice_id:orders:MapObject with the information about the order 
invoices:invoice_id:orders:idString(100)ID of the order1601541121984init
invoices:invoice_id:orders:statusString(100)Current status of the orderapproved
invoices:invoice_id:orders:amountIntegerAmount of currency in the order999
invoices:invoice_id:orders:created_atString(100)Date of creation of the order2020-10-01 08:32:24
invoices:invoice_id:orders:processed_atString(100)Order processing date2020-10-01 08:32:24
invoices:invoice_id:orders:failed_reasonString(36)Error code3.02
invoices:invoice_id:orders:operationString(100)Type of operationpay
invoices:invoice_id:orders:retry_attemptIntegerRetry attempt number1
metadataObject  
metadata:next_page_iteratorStringThe unique hash for receiving new data. If it's null - all data was successfully getting by the merchanteyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9

Subscriptions Report Response Sample

{
    "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
    }
}

PayPal Disputes

POST https://reports.solidgate.com/api/v1/apm-orders/paypal-disputes

PayPal Disputes Report Request Body Parameters

ParameterMandatoryTypeDescriptionValue sample
date_fromYesStringStart date and time of orders and transactions creating. Format "Y-m-d H:i:s"2019-07-07 11:00:00
date_toYesStringEnd date and time of orders and transactions creating. Format "Y-m-d H:i:s"2019-07-14 13:00:00
next_page_iteratorNoStringIf it is necessary to perform pagination in the request body, add the field with the value from the previous response.7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8=

PayPal Disputes Report Request Sample

{
  "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

ParameterTypeDescriptionValue sample
disputesListList of disputes 
disputes:dispute_idStringDispute IDPP-D-85112454
disputes:order_idStringOrder IDfdsyf9s8d69ds6gds96
disputes:dispute_amountIntegerDispute amount - integer without fractional component (i.e cents). For instance, 1020 means 10 USD and 20 cents1020
disputes:dispute_currencyStringDispute currency (3 letter code under ISO 4217)USD
disputes:reasonStringReason for the disputeMERCHANDISE_OR_SERVICE_NOT_RECEIVED
disputes:statusStringStatus of the disputeWAITING_FOR_BUYER_RESPONSE
disputes:dispute_life_cycle_stageStringStage of dispute life-cycleINQUIRY
disputes:dispute_channelStringThe channel by which dispute was received INTERNAL
disputes:dispute_create_timeStringWhen the dispute was created2020-07-02 23:39:06
disputes:dispute_update_timeStringThe last time the dispute was updated2020-07-08 1:40:44
disputes:customer_emailStringEmail of the customertest@gmail.com
disputes:seller_response_due_dateStringWhen seller responded to the dispute2020-09-14 16:29:12
disputes:created_atStringTime of the dispute creation2020-08-23 12:05:28
metadataObject  
metadata:next_page_iteratorStringUnique hash for receiving new data. If it's null - all data was successfully getting by the merchant7kUDYhPqjhcLDfzo00hfoazbdLexUCadNzFQ3+34Xw8=

PayPal Disputes Report Response Sample | Success

"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"
        } 
]

Financial Entries

The report can be generated in two ways:

  • by time range (date_from, date_to)
  • by settlement_id

The report comes in .csv format.

POST https://reports.solidgate.com/api/v1/finance/financial_entries

Financial Entries Report Request Body Parameters

ParameterMandatoryTypeDescriptionValue sample
date_fromYesStringStart date and time of financial entries creating. Format "Y-m-d H:i:s"2022-07-07 11:00:00
date_toYesStringEnd date and time of of financial entries creating. Format "Y-m-d H:i:s"2022-07-14 13:00:00

Financial Entries Report Request Sample

{
  "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

ParameterMandatoryTypeDescriptionValue sample
settlement_idYesStringID of the settlement2A1N0V1

Financial Entries Report Request Sample

{
  "settlement_id": "2A1N0V1"
}

Financial Entries Report Response Body Parameters

ParameterTypeValue sample
report_urlStringhttps://reports.solidgate.com/api/v1/finance/financial_entries/report/fin_220808_143924_test/download

Financial Entries Report Response Sample

{
  "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.

GET https://reports.solidgate.com/api/v1/finance/financial_entries/report/{report_id}/download

Response codeDescription
204Report is not ready.
302Redirect to one-time S3 download report link. Actions completed successfully.
404Report not found.
410Report unavailable (expired). It is checked that the report was collected >= 30 days ago.

Financial Entries CSV Report Parameters

ParameterTypeDescriptionValue sample
idStringFinancial record ID.ft_1mc2209090000_fKJScPc
order_idOrder ID generated by the merchant.mvbcdj1335d
external_psp_order_idOrder ID generated by Solidgate.2343253452323412sd12ds
created_atThe 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_providerThe date on which the transaction or fee occurred. Dates in the timezone of the provider.2021-07-23 17:39:50
transaction_datetime_utcThe date on which the transaction or fee occurred. Dates in UTC.2021-07-23 17:39:50
accounting_dateDetermines which settlement or invoice the record will be included in. 
Only populated for provider = 'Solidgate'. Format: YYYY-MM-DD
2021-07-23
amountThe original amount of the financial record. Expressed in minor currency units (as an integer). For instance, 1020 means 10 USD and 20 cents.1020
currencyThe currency in which the financial record is initially defined (3 letter code under ISO 4217).EUR
currency_minor_unitsMinor units of the currency.100
payout_amountThe payout amount. Expressed in minor currency units (as an integer). For instance, 1020 means 10 USD and 20 cents.1020
payout_currencyThe payout currency (3 letter code under ISO 4217).EUR
payout_currency_minor_unitsMinor units of the payout currency.100
record_type_keyType of financial record.
For example: SALE, REFUND, DISCOUNT FEE, CHARGEBACK FEE.
SALE
providerName of the Provider that processed the transaction.Solidgate
payment_methodPayment method.card
card_brandCard Brand.VISA
geo_countryCustomer country. The code shall have the format ISO 3166-1 alpha-3.USA
issuing_countryСountry of the issuing bank.USA