OpenAPI specification
Full schema for programmatic integration: endpoint paths, request/response shapes, and field definitions.
Get started quickly
Solidgate offers APIs for processing and managing payments via HTTP/REST or Solidgate libraries, with JSON as the data exchange format.
Frontend SDK
These are the primary frontend libraries. Use them to embed payment forms directly in your client-side application.
Backend SDK
Multiple backend libraries to manage server-side processing, advanced integrations, form resign flows, and reconciling orders.
Enhance understanding with our payment guide.
For help, contact us.
Implementing automated retry logic for - [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 subseque - [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.
If a transaction is undergoing 3D Secure verification, the response indicates an order status of < - [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, fr - [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 payme - [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 u - [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 auto - [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. - [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 sc ## 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 fo - [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 ap - [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. refund request to return funds for successfully processed orders. - [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 cha - [POST PayPalDispute](https://api-docs.solidgate.com/api/alternative-payment-methods/webhook-paypal-dispute.md): Webhooks delivers critical insights into each Webhooks enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert, - [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 ## 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.
- [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 filt - [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 informati - [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 c - [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 cr - [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 - [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 - [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 - [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 th - [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 di ## 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 a - [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, - [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 co - [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 w - [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 ## 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 subscript - [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 - [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 - [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 pausemodif - [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 sche - [POST /subscription/cancel](https://api-docs.solidgate.com/api/manage-subscriptions/cancel-subscription.md): By using this method, merchants can cancel - [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 a - [POST /subscription/restore](https://api-docs.solidgate.com/api/manage-subscriptions/restore-subscription.md): By using this method, merchants can restore the specific subs - [POST Billing](https://api-docs.solidgate.com/api/manage-subscriptions/webhook-subscription-status.md): Webhooks for subscription status provide real-time notificat ## 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 d - [POST /subscription/list](https://api-docs.solidgate.com/api/retrieve-subscription-data/retrieve-subscriptions-by-customer.md): This method allows the merchant to retrieve - [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 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):
- [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.Please note that the payment page link expires in 24 hours.
- [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 informatio - [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 trans - [POST /subscriptions](https://api-docs.solidgate.com/api/reports/retrieve-subscriptions.md): The report offers a comprehensive overview for merchants, detailing customer subscriptions, paymen - [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 - [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. Th - [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 gen - [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 - [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 financ - [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 report provides a comprehensive view of routing decisions and execution flow for orders - [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 ev ## 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, compliTwo identical URLs cannot be configured for one channel.