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

Node.js PHP Go Kotlin Python

Enhance understanding with our payment guide.
For help, contact us.

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 ### merchant Unique public key provided upon registration. Send it on every authenticated request. Type: apiKey In: header Name: merchant ### signature Request signature that verifies merchant authenticity on the payment gateway server. Type: apiKey In: header Name: signature ## Download OpenAPI description - [Solidgate • API reference](https://api-docs.solidgate.com/_bundle/api/@v1/index.yaml) ## Card payments - [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. - [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 identi - [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 identifi - [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 - [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. - [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 operati - [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 h - [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 au - [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 w - [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. - [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. - [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 thei - [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 - [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 upd - [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. Dupli - [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 proces - [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 ## Alternative payment methods - [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. - [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 t - [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_methodalipay, mbway or wechatpay. - [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 c - [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 - [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`, - [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 - [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 ide - [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 - [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 pr - [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. - [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 sta - [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. - [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 un - [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 /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. - [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 filter - [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, you can update an existing product price. You can update a price only when all associated subscriptions are in expired status. If the price has no associated subscriptions, you c - [POST /products/{product_id}/prices/{product_price_id}/archive](https://api-docs.solidgate.com/api/products-and-prices/archive-product-price.md): By using this method, you can archive an existing product price. Only non-default prices that are not already archived can be archived.To archive the current default price, first promote a different p - [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 ## Taxes - [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 break - [GET /transactional/report/{report_id}/download](https://api-docs.solidgate.com/api/taxes/download-tax-transactional.md): Retrieves a generated transactional tax report in CSV format. In a successful response, you will be redirected to S3 to download the file. - [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 acc - [GET /summary/report/{report_id}/download](https://api-docs.solidgate.com/api/taxes/download-tax-summary.md): Retrieves a generated summary tax report in CSV format. In a successful response, you will be redirected to S3 to download the file. - [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 ## Manage subscriptions - [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 effici - [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 pro - [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. - [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. - [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 activ - [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. - [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. - [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. - [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. - [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 ## Retrieve subscription data - [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 rela - [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. - [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. - [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 - [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. - [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-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 - [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. - [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 - [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. - [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 - [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. - [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 - [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. - [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. - [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 /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 - [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 - [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 complet - [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 reve - [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 f - [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 rep - [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 succes - [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. Th - [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 identifyi - [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. - [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 essenti - [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 trans - [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 conn ## Files upload - [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, compli