# Solidgate • API reference The Solidgate API is a payment gateway API that enables merchants to securely process and manage transactions, including card payments and alternative payment methods.

OpenAPI specification

Full schema for programmatic integration: endpoint paths, request/response shapes, and field definitions.

YAML JSON

Get started quickly

Solidgate offers APIs for processing and managing payments via HTTP/REST or Solidgate libraries, with JSON as the data exchange format.

Postman

Frontend SDK

These are the primary frontend libraries. Use them to embed payment forms directly in your client-side application.

React Vue Angular

Backend SDK

Multiple backend libraries to manage server-side processing, advanced integrations, form resign flows, and reconciling orders.

JS Node.js php PHP Go Kotlin Python

Enhance understanding with our payment guide.
For help, write to support@solidgate.com.

Version: 1.0.0 License: Terms and policies ## Servers Card payments API ``` https://pay.solidgate.com/api/v1 ``` Alternative payment methods API ``` https://gate.solidgate.com/api/v1 ``` Subscriptions API ``` https://subscriptions.solidgate.com/api/v1 ``` Payment Page API ``` https://payment-page.solidgate.com/api/v1 ``` Reports API ``` https://reports.solidgate.com/api/v1 ``` Risks API ``` https://risks.solidgate.com/api/v1 ``` General API ``` https://api.solidgate.com/api/v1 ``` ## Security ### MerchantID Type: apiKey In: header Name: Merchant id ## Download OpenAPI description [Solidgate • API reference](https://api-docs.solidgate.com/_bundle/api/@v1/index.yaml) ## Card payments Solidgate API for card payments allows merchants to securely integrate with a payment gateway to process and manage card transactions. ### Charge - [POST /charge](https://api-docs.solidgate.com/api/card-payments/make-card-charge.md): Basic operation withdraws funds from the cardholder’s account, with optional 3D Secure verification, and tokenizes the cardholder's data for future payments. ### Google Pay - [POST /google-pay](https://api-docs.solidgate.com/api/card-payments/make-google-pay.md): An API request for Google Pay allows a merchant to initiate a Google Pay transaction, by sending a request to the Google Pay API with the required parameters such as amount, currency, and order identifier, which will be processed, and the response will be sent back with the transaction details. ### Apple Pay - [POST /apple-pay](https://api-docs.solidgate.com/api/card-payments/make-apple-pay.md): An API request for Apple Pay allows a merchant to initiate an Apple Pay transaction, by sending a request to the Apple Pay API with the required parameters such as amount, currency, and order identifier, which will be processed, and the response will be sent back with the transaction details. ### Incremental auth - [POST /increment](https://api-docs.solidgate.com/api/card-payments/increment-card-auth.md): Incremental authorization operation creates additional authorization transactions on top of an estimated authorization to increase the total authorized amount for the order. The payment configuration conditions must be met. Maximum 50 increments allowed per order. This operation creates a auth transaction with authorization_type incremental within the same order. ### Recurring - [POST /recurring](https://api-docs.solidgate.com/api/card-payments/make-card-recurring.md): Method that allows you to initiate tokenized payments. In contrast to charge request, token previously received has to be sent in the request instead of cardholder data. ### Resign - [POST /resign](https://api-docs.solidgate.com/api/card-payments/make-card-resign.md): Resign one-click enables token-based transactions (1-click payments) with additional CVV verification, exclusive to PCI-DSS certified merchants. Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under 120 attempts. ### Refund - [POST /refund](https://api-docs.solidgate.com/api/card-payments/refund-card-order.md): Request for transferring funds back to the cardholder. Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under 120 attempts. ### Void - [POST /void](https://api-docs.solidgate.com/api/card-payments/void-card-order.md): The void request serves to nullify pre-existing auth transactions by revoking the initial authorization. Be advised that the void method can only be executed for auth transactions. Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under 120 attempts. ### Settle - [POST /settle](https://api-docs.solidgate.com/api/card-payments/settle-card-order.md): The settle method facilitates the settlement of previously auth transactions. Be advised that if the subsequent settle amount is less than the initial auth transaction amount, the difference will be refunded to the cardholder's account. Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under 120 attempts. ### Check order status - [POST /status](https://api-docs.solidgate.com/api/card-payments/get-status-card-order.md): The check order status request helps to retrieve the present status of a given order. If a transaction is undergoing 3D Secure verification, the response indicates an order status of 3ds_verify. ### Get ARN codes - [POST /arn-code](https://api-docs.solidgate.com/api/card-payments/get-arn-codes.md): Get ARN codes request obtains ARN codes for specific orders, providing essential information about refunds, currencies, and transaction statuses. ### Updated card order - [POST CardsOrderStatus](https://api-docs.solidgate.com/api/card-payments/webhook-card-order-status.md): Webhooks allow merchants to securely receive real-time notifications in card order status changes, for example, from processing to auth_failed, and automatically trigger actions or updates in their own systems based on those events. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ### Created network token - [POST NetworkTokenCreated](https://api-docs.solidgate.com/api/card-payments/webhook-network-token-created.md): Webhooks provide merchants with real-time notifications, indicating that the network token associated with a payment card has been issued by Visa or Mastercard. Merchants can then automatically update their systems based on these notifications. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ### Updated network token - [POST NetworkTokenUpdated](https://api-docs.solidgate.com/api/card-payments/webhook-network-token-updated.md): Webhooks provide merchants with real-time notifications when the network token associated with a payment card is updated by Visa or Mastercard. These notifications allow merchants to automatically update their systems based on the events. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ### Received dispute - [POST Chargeback](https://api-docs.solidgate.com/api/card-payments/webhook-chargeback.md): Webhooks for chargebacks allow merchants to securely receive real-time notifications of chargeback events and automatically trigger actions or updates in their own systems based on those events. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ### Received prevention alert - [POST CardPreventAlert](https://api-docs.solidgate.com/api/card-payments/webhook-alert-prevent.md): Webhooks enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ### Received fraud alert - [POST FraudAlert](https://api-docs.solidgate.com/api/card-payments/webhook-fraud-alert.md): Webhooks for fraud alerts allow merchants to securely receive real-time notifications of fraud reported by card schemes. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ## Alternative payment methods Solidgate API for alternative payment methods allows merchants to securely integrate with a payment gateway to process and manage APM transactions such as PayPal, Pay by Bank, etc. ### Init payment - [POST /init-payment](https://api-docs.solidgate.com/api/alternative-payment-methods/create-apm-init-payment.md): Operation for the initiation of a payment using an APMs, performs order creation and prepares the transaction for payment, allowing the customer to proceed with the payment process. ### Recurring - [POST /v1/recurring](https://api-docs.solidgate.com/api/alternative-payment-methods/make-apm-recurring.md): Initiate a token-based recurring payment refers to an automatic billing applied to a customer's payment method at predetermined intervals. This process involves securely storing a token representing the customer's payment details and using it for subsequent transactions without requiring input each time. ### Revoke token - [POST /v1/recurring-token/cancel](https://api-docs.solidgate.com/api/alternative-payment-methods/revoke-apm-recurring-token.md): Request to revoke a recurring token for alternative payment methods. Available for tokens initiated with payment_method alipay, mbway or wechatpay. ### Refund - [POST /v1/refund](https://api-docs.solidgate.com/api/alternative-payment-methods/refund-apm-order.md): Initiate a refund request to return funds for successfully processed orders. It is important to note that, for instance, refunds might not be accessible or could be restricted when using alternative cash-based payment methods. ### Check order status - [POST /v1/status](https://api-docs.solidgate.com/api/alternative-payment-methods/get-status-apm-order.md): Request for receiving current order status. The key benefit is that it allows merchants to efficiently monitor and manage their payments by providing comprehensive information about the order's status, payment method, transaction details, and customer information. ### Updated alternative order - [POST APMOrderStatus](https://api-docs.solidgate.com/api/alternative-payment-methods/webhook-apm-order-status.md): Webhooks for alternative payment method status enable merchants to securely receive real-time notifications of changes in the status of alternative payment methods, such as processing or declined, and automatically initiate actions or updates in their own systems based on those events. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ### Received PayPal dispute - [POST PayPalDispute](https://api-docs.solidgate.com/api/alternative-payment-methods/webhook-paypal-dispute.md): Webhooks delivers critical insights into each PayPal dispute and its lifecycle, enabling businesses to manage disputes effectively and enhance customer satisfaction. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ### Received prevention alert - [POST APMPreventAlert](https://api-docs.solidgate.com/api/alternative-payment-methods/webhook-apm-alert-prevent.md): Webhooks enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert, specifically for the PayPal method. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ### Revoked recurring token - [POST APMRevokedRecurringToken](https://api-docs.solidgate.com/api/alternative-payment-methods/webhook-apm-revoked-recurring-token.md): Webhooks notify about a revoked recurring token for alternative payment methods. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ## Products and prices Solidgate API for billing management allows merchants to create and update products and pricing effectively, ensuring businesses can adapt to diverse customer needs and preferences. ### Create product - [POST /products](https://api-docs.solidgate.com/api/products-and-prices/create-product.md): This method allows merchants to create new products by providing the required details. Products created via API cannot be edited in the Solidgate Hub unless a default price is set. To add a default price and enable editing, use the create product price operation. ### Get product list - [GET /products](https://api-docs.solidgate.com/api/products-and-prices/get-products.md): By using this method, merchants can find products and retrieve their details by applying filters such as product identifier, status, trial availability, and sorting criteria with pagination support. ### Update product - [PATCH /products/{product_id}](https://api-docs.solidgate.com/api/products-and-prices/update-product.md): This method updates the existing product with specified details and returns the updated product information. Recurring products can only be updated when all associated subscriptions are in expired status. Products without subscriptions can be updated without restrictions. ### Get product by ID - [GET /products/{product_id}](https://api-docs.solidgate.com/api/products-and-prices/get-product-by-id.md): This method allows merchants to obtain the existing product by its identifier. ### Archive product - [POST /products/{product_id}/archive](https://api-docs.solidgate.com/api/products-and-prices/archive-product.md): By using this method, merchants can archive products. Note that the archived product cannot be restored or added to new subscriptions. Existing subscriptions with the archived product remain active until cancelled. ### Create product price - [POST /products/{product_id}/prices](https://api-docs.solidgate.com/api/products-and-prices/create-product-price.md): By using this method, merchants can create a new product price with specified details and retrieve the created product price information. ### Get product prices - [GET /products/{product_id}/prices](https://api-docs.solidgate.com/api/products-and-prices/get-product-prices.md): This method allows merchants to retrieve product prices based on the specified filter criteria and pagination settings, returning the results along with pagination information. ### Retrieve prices - [POST /products/prices/list](https://api-docs.solidgate.com/api/products-and-prices/find-prices.md): This method allows merchants to retrieve prices in bulk based on specified filter criteria with pagination settings. Without filters, the request returns all prices in the merchant account. With filters, each filter field requires a value to avoid validation errors. ### Update product price - [PATCH /products/{product_id}/prices/{product_price_id}](https://api-docs.solidgate.com/api/products-and-prices/update-product-price.md): By using this method, merchants can update the existing product price, providing the updated product price details. Recurring products can only be updated when all associated subscriptions are in expired status. Products without subscriptions can be updated without restrictions. ### Calculate product price - [POST /products/calculatePrice](https://api-docs.solidgate.com/api/products-and-prices/calculate-product-price.md): This method allows merchants to calculate an estimated product price for a specific location. Calculated prices returned by this endpoint are estimates. The final charged amount may differ at the time of billing due to product updates, tax changes, or other configuration changes. ## Taxes Solidgate’s tax solution empowers businesses to manage and automate tax calculations across multiple regions efficiently. By integrating the tax solution, merchants can support accurate tax handling and compliance with local regulations. ### Transactional tax - [POST /transactional](https://api-docs.solidgate.com/api/taxes/tax-transactional.md): The transactional tax report aggregates every tax-relevant transaction into one file, combining order and product identifiers, channel and legal entity, processing amounts and currency, full tax breakdown, include type, rate, taxable and tax amounts, location, and BIN/IP geography for delivering a concise, high-level view of liabilities across entities and jurisdictions. In a successful response, you receive a link to the file report_url. The tax data are in a CSV file, which can be found at the link. ### Download transactional tax - [GET /transactional/report/{report_id}/download](https://api-docs.solidgate.com/api/taxes/download-tax-transactional.md): Retrieves a ready-generated transactional tax report CSV. Send the request and, if the file exists, you get a short-lived pre-signed S3 URL that immediately starts the download. ### Summary tax - [POST /summary](https://api-docs.solidgate.com/api/taxes/tax-summary.md): The summary tax report aggregates your tax data into a single file, grouping figures by every unique combination of legal entity, tax location, and processing currency configured in your Solidgate account. It includes key metrics such as taxable turnover, calculated tax amount, and net revenue for each group, giving you a clear, high-level view of your liabilities across jurisdictions. In a successful response, you receive a link to the file report_url. The tax data are in a CSV file, which can be found at the link. ### Download summary tax - [GET /summary/report/{report_id}/download](https://api-docs.solidgate.com/api/taxes/download-tax-summary.md): Retrieves a ready-generated summary tax report CSV. Send the request and, if the file exists, you get a short-lived pre-signed S3 URL that immediately starts the download. ### Calculated tax - [POST CalculatedTax](https://api-docs.solidgate.com/api/taxes/webhook-calculated-tax.md): Webhooks provide merchants with instant notifications when the Solidgate tax solution calculates the tax amount of the transaction. These notifications allow merchants to notify users about paid taxes or to save tax information in real-time on the merchant’s side. It delivers key tax details, such as calculated amounts and tax type breakdowns, ensuring accurate and automated tax application for transactions. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. ## Manage subscriptions Solidgate API for subscriptions empowers merchants in efficiently and securely managing subscriptions for a positive customer experience and business growth. Merchants can easily handle their subscriptions using the available methods such as switching subscription products, pausing and resuming services, cancelling subscriptions, and providing customers with the option to update payment information. ### Update subscription - [POST /subscription/update](https://api-docs.solidgate.com/api/manage-subscriptions/update-subscription.md): By using this method, merchants can update an active subscription by modifying the trial period, applying a discount, or changing the product. It allows multiple changes in a single request for efficient subscription management and customer retention. ### Switch product - [POST /subscription/switch-subscription-product](https://api-docs.solidgate.com/api/manage-subscriptions/switch-subscription-product.md): By using this method, merchants can update the product in the active subscription with a new one. After the switch request is made, a callback confirms the update and includes the new subscription product. The updated settings take effect on the next billing date. The switch is subject to conditions related to currency and location compatibility between the current and new products. ### Update subscription token - [POST /subscription/update-token](https://api-docs.solidgate.com/api/manage-subscriptions/update-subscription-token.md): This method provides a mechanism for merchants to update the payment token when the customer's preferred payment method changes. ### Create subscription pause - [POST /subscriptions/{subscription_id}/pause-schedule](https://api-docs.solidgate.com/api/manage-subscriptions/create-subscription-pause.md): By using this method, merchants can schedule a subscription pause, setting the specific start and end dates for the pause period. ### Update subscription pause - [PATCH /subscriptions/{subscription_id}/pause-schedule](https://api-docs.solidgate.com/api/manage-subscriptions/update-subscription-pause.md): By using this method, merchants can modify the existing pause schedule, including the possibility of adjusting the start and end dates of the pause period. Note that if the subscription pause is active, only its end date can be updated, while an inactive pause allows for updates to both start and end dates. ### Remove subscription pause - [DELETE /subscriptions/{subscription_id}/pause-schedule](https://api-docs.solidgate.com/api/manage-subscriptions/delete-subscription-pause.md): This method provides a way to delete the scheduled pause, reverting the subscription to its previous active state or as specified. ### Cancel subscription - [POST /subscription/cancel](https://api-docs.solidgate.com/api/manage-subscriptions/cancel-subscription.md): By using this method, merchants can cancel the specific subscription by its subscription identifier. ### Cancel subscriptions by customer - [POST /subscription/cancel-by-customer](https://api-docs.solidgate.com/api/manage-subscriptions/cancel-subscriptions-by-customer.md): By using this method, the merchant can cancel all subscriptions for the specific customer. ### Restore subscription - [POST /subscription/restore](https://api-docs.solidgate.com/api/manage-subscriptions/restore-subscription.md): By using this method, merchants can restore the specific subscription of their customer in case it was cancelled. ### Subscription payment updates - [POST Billing](https://api-docs.solidgate.com/api/manage-subscriptions/webhook-subscription-status.md): Webhooks for subscription status provide real-time notifications about changes in subscription status. The webhook structure is similar to the subscription status method but additionally includes the callback_type parameter in the response object. There are two versions of subscription events: legacy and extended. The extended version offers an enhanced webhook event set with more detail and context, giving merchants deeper insights into subscription stages for better management and analysis. The legacy version remains supported until the end of June 2026. Duplicate webhook events can occur. Implement idempotency on your end to avoid processing the same event twice. Parameters for each callback type can vary based on factors such as product type, payment method, trial availability, or other specific conditions. ## Retrieve subscription data Solidgate API for accessing subscription information provides merchants with the ability to obtain precise and up-to-date details regarding customer subscriptions. To get in-depth insights into customer subscriptions, use subscription report that is specifically designed to retrieve and combine all subscription-related data. ### Get subscription status - [POST /subscription/status](https://api-docs.solidgate.com/api/retrieve-subscription-data/get-subscription-status.md): By using this method, merchants can retrieve subscription data by subscription identifier and obtain its details, such as the start date, status, and the information about the most recent invoice related to the subscription. ### Retrieve subscriptions by customer - [POST /subscription/list](https://api-docs.solidgate.com/api/retrieve-subscription-data/retrieve-subscriptions-by-customer.md): This method allows the merchant to retrieve all subscriptions and their statuses for the specific customer by the customer identifier. ### List invoices by subscription - [POST /subscription/invoice/list](https://api-docs.solidgate.com/api/retrieve-subscription-data/list-invoices-by-subscription-id.md): By using this method, merchants can get a list of invoices related to a specific subscription. ### List orders by invoice - [POST /subscription/order/list](https://api-docs.solidgate.com/api/retrieve-subscription-data/list-orders-by-invoice-id.md): By using this method, merchants can retrieve a list of orders associated with a particular invoice. ## Fraud prevention Solidgate API for fraud prevention enables merchants to set up and manage fraud prevention lists, helping to block fraudulent activities while ensuring secure transactions. By configuring fraud prevention lists, merchants can define specific conditions to allow or reject transactions, enhancing the security and reliability of their payment operations. ### Create fraud prevention list items - [POST /fraud-prevention-list-items/create](https://api-docs.solidgate.com/api/fraud-prevention/fraud-prevention-list-items-create.md): This method allows you to add new items to fraud prevention list linked to the merchant's account. ### List fraud prevention list items - [POST /fraud-prevention-list-items/list](https://api-docs.solidgate.com/api/fraud-prevention/fraud-prevention-list-items-list.md): This method retrieves existing fraud prevention list items linked to the merchant's account. ### Delete fraud prevention list item - [DELETE /fraud-prevention-list-items/{id}](https://api-docs.solidgate.com/api/fraud-prevention/fraud-prevention-list-items-delete.md): This method allows you to delete an existing fraud prevention list item linked to the merchant's account. ## Dispute representment Solidgate API for card dispute representment and PayPal dispute representment representment enables merchants to defend card and PayPal disputes by uploading evidence files, helping to protect revenue and resolve disputed orders efficiently. ### Create dispute representment - [POST /dispute-representments/create](https://api-docs.solidgate.com/api/dispute-representment/dispute-representments-create.md): This method allows you to initiate a dispute representment case with associated evidence files. ### Enrich dispute representment - [POST /dispute-representments/enrich](https://api-docs.solidgate.com/api/dispute-representment/dispute-representments-enrich.md): This method allows you to enrich dispute representment with additional content. ## Payment page Solidgate Payment Page allows merchants to securely redirect customers to a payment gateway's hosted page for completing transactions, without the need for custom integration on the merchant's website. ### Create page - [POST /init](https://api-docs.solidgate.com/api/payment-page/create-payment-page.md): Please note that the payment page link expires in 24 hours. ### Deactivate page - [POST /deactivate](https://api-docs.solidgate.com/api/payment-page/deactivate-payment-page.md): Deactivate an active payment page to prevent further use. ## Payment link Solidgate Payment Link feature offers a hassle-free way to conduct online sales without integration, allowing merchants to share a URL that leads customers to a secure payment page for both one-time and subscription transactions. ### Create link - [POST /link/init](https://api-docs.solidgate.com/api/payment-link/create-payment-link.md): Payment links are code-free and reusable, allowing you to share them as many times as needed. ### Deactivate link - [POST /link/deactivate](https://api-docs.solidgate.com/api/payment-link/deactivate-payment-link.md): Deactivate an active payment link to prevent further use. ## Manage webhooks Solidgate API for webhook management allows merchants to create, update, list, and delete webhook endpoint configurations. ### Create webhook endpoint - [POST /webhooks/endpoints](https://api-docs.solidgate.com/api/manage-webhooks/webhook-endpoint-create.md): This method allows you to configure a webhook endpoint to receive specified events. Two identical URLs cannot be configured for one channel. ### List webhook endpoints - [GET /webhooks/endpoints](https://api-docs.solidgate.com/api/manage-webhooks/webhook-endpoint-list.md): This method retrieves a list of your previously created webhook endpoints. ### Update webhook endpoint - [PATCH /webhooks/endpoints/{id}](https://api-docs.solidgate.com/api/manage-webhooks/webhook-endpoint-update.md): This method allows you to update an existing webhook endpoint. For that, you need to provide the endpoint identifier and the new configuration. ### Delete webhook endpoint - [DELETE /webhooks/endpoints/{id}](https://api-docs.solidgate.com/api/manage-webhooks/webhook-endpoint-delete.md): This method allows you to delete an existing webhook endpoint. For that, you need to provide the endpoint identifier you want to delete. ## Reports Solidgate API for reports allows merchants to securely access transaction data and generate customized reports for analyzing and tracking the performance of their payment operations. With Solidgate’s reconciliation functionality, merchants can track cash daily, identify fund flow gaps, gain complete transaction lifecycle visibility, implement strong financial controls, and establish scalable financial processes.

Solidgate data comes with a 60-minute delay, thus it is not recommended for real-time analysis.

Please note that reports may be inaccessible for about 30 minutes on Wednesdays at 5:00 PM (UTC) due to scheduled external maintenances. Once complete, all reports will be available with data preserved.

### Card orders - [POST /card-orders](https://api-docs.solidgate.com/api/reports/retrieve-card-orders.md): The report provides essential data for merchants, including transaction details, customer information, and technical insights, facilitating comprehensive order tracking, financial reconciliation, and enhanced operational and marketing strategies. This report uses the updated_at as the default parameter for unloading data, which reflects the latest update to card orders. ### APM orders - [POST /apm-orders](https://api-docs.solidgate.com/api/reports/retrieve-apm-orders.md): The report is essential for merchants using alternative payment methods, offering comprehensive transaction details, including order IDs, statuses, amounts, customer information, crucial for a complete understanding of APM transaction dynamics. This report uses the updated_at as the default parameter for unloading data, indicating the latest update to the APM orders. ### Subscriptions - [POST /subscriptions](https://api-docs.solidgate.com/api/reports/retrieve-subscriptions.md): The report offers a comprehensive overview for merchants, detailing customer subscriptions, payment methods, key customer data, and associated invoices, which are important for managing recurring revenues, customer retention, and informed decision-making in subscription-based businesses. The updated_at parameter is used when unloading subscription data, indicating the most recent update to a subscription. ### Chargebacks - [POST /card-orders/chargebacks](https://api-docs.solidgate.com/api/reports/retrieve-card-chargebacks.md): The report is essential for merchants, providing exhaustive insights into each chargeback, including identifiers, dates, types, amounts, reasons, and related original order details, which is crucial for understanding chargeback patterns, enhancing dispute resolution, and fraud prevention. Chargeback information is unloaded using the updated_at as the default parameter, which reflects the date when the latest chargeback flow was created. ### PayPal disputes - [POST /apm-orders/paypal-disputes](https://api-docs.solidgate.com/api/reports/retrieve-apm-paypal-disputes.md): The report is crucial, offering detailed insights on each PayPal dispute and lifecycle stage. These details are essential for effective dispute management and enhancing customer satisfaction. This report uses the created_at as the default parameter for unloading data. ### Prevention alerts - [POST /prevention_alerts](https://api-docs.solidgate.com/api/reports/prevention-alerts-by-date.md): The report retrieves data to identify and resolve potential issues, thereby preventing the generation of alerts. This report uses the created_at as the default parameter for unloading data. In a successful response, the report_url field will contain a link to the file. ### Download prevention alerts - [GET /prevention_alerts/report/{report_id}/download](https://api-docs.solidgate.com/api/reports/download-prevention-alerts.md): The report offering detailed information on prevention alerts. It provides insights into each alert, including unique identifiers, alert types, amounts, outcomes, and the alert generation timeline. The report unloads data based on the date range parameters that corresponds to the date the operation was executed. In a successful response, you will be redirected to S3 to download the file. ### Card fraud alerts - [POST /card-orders/fraud-alerts](https://api-docs.solidgate.com/api/reports/retrieve-card-fraud-alerts.md): The report is vital for merchants, providing detailed fraud-related information such as order IDs, amounts, and timings, along with specific fraud types and reason codes, crucial for swiftly identifying, analyzing, and formulating effective strategies to enhance transaction security. The created_at as the default parameter is used to unload fraud alert data. It specifies the exact time when a fraud alert was created. ### Financial entries by date range - [POST /financial_entries](https://api-docs.solidgate.com/api/reports/financial-entries-by-date.md): In a successful response, you will receive a link to the file report_url. The financial data are in a CSV file, which can be found at the link. Data is available for export from the July 2022. ### Download financial entries - [GET /financial_entries/report/{report_id}/download](https://api-docs.solidgate.com/api/reports/download-financial-entries.md): The report offers an extensive overview of financial transactions, detailing financial record IDs, order and transaction IDs, dates, amounts, currencies, payment methods, and geographical data essential for comprehensive financial analysis and management. The report unloads data based on the created_at + 4 hours parameter, which corresponds to the date the operation was executed. In a successful response, you will be redirected to S3 to download the file. ### Routing events - [POST /routing/events](https://api-docs.solidgate.com/api/reports/routing-events-by-date.md): The report provides a comprehensive view of routing decisions and execution flow for orders processed through routing configurations. It captures the complete sequence of routing events for each transaction, including selected steps, skipped steps with reasons, 3DS decisions, and connector account details. This report uses the created_at as the default parameter for unloading data. The date range between date_from and date_to must not exceed 36 days. In a successful response, the report_url field will contain a link to the file. ### Download routing events - [GET /routing/events/report/{report_id}/download](https://api-docs.solidgate.com/api/reports/download-routing-events.md): The report offers detailed information on routing events. It provides insights into each event, including unique identifiers, configuration and version, route and step details, 3DS decisions, and connector account selected for processing. The report unloads data based on the date range parameters that corresponds to the date the operation was executed. In a successful response, you will be redirected to S3 to download the file. ## Files upload Solidgate API for file uploads enables to securely upload files to the system, such as evidence for chargeback disputes or documents required for verification purposes. ### Create file - [POST /file/get-upload-url](https://api-docs.solidgate.com/api/files-upload/create-upload-url.md): This method allows to create a file upload request by generating a unique file_id to reference the file. This file can be used for various purposes such as evidence for dispute representment, compliance checks, or other necessary documentation uploads.