# Solidgate API Reference Solidgate API v2 follows a consistent, predictable endpoint structure across all operations. OpenAPI specificationFull schema for programmatic integration: endpoint paths, request/response shapes, and field definitions. YAML JSON Get started quicklySolidgate offers APIs for processing and managing payments via HTTP or Solidgate libraries, with JSON as the data exchange format. Postman Frontend SDKThese are the primary frontend libraries. Use them to embed payment forms directly in your client-side application. React Vue Angular Backend SDKMultiple backend libraries to manage server-side processing, advanced integrations, form resign flows, and reconciling orders. PHP Node.js Go Kotlin Python Enhance understanding with our payment guide. For help, contact us. Version: 2.0.0 License: Terms and policies ## Servers Solidgate API ``` https://api.solidgate.com/v2 ``` ## Security ### bearerAuth Secret value sent in the `Authorization` header using the `Bearer` scheme. Type: http Scheme: bearer Bearer Format: asec_xxx ### signatureAuth Base64-encoded HMAC-SHA256 of the raw request body bytes, computed with the webhook endpoint secret prefixed with `wsec_`. During secret rotation each delivery carries two `Signature` headers, one per secret, the new secret first. Accept the event if any of them matches. Some HTTP frameworks merge repeated headers into one comma-separated value, so split it before comparing. Type: apiKey In: header Name: Signature ## Download OpenAPI description - [Solidgate API Reference](https://api-docs.solidgate.com/_bundle/api/@v2/index.yaml) ## API keys - [POST /api-keys/create](https://api-docs.solidgate.com/api/v2/api-keys/create-api-key.md): Creates a new API key for authentication and authorization. This endpoint requires an account-level API key. - [POST /api-keys/list](https://api-docs.solidgate.com/api/v2/api-keys/list-api-key.md): Retrieves a paginated list of API keys for the specified account. This endpoint requires an account-level API key. - [POST /api-keys/get](https://api-docs.solidgate.com/api/v2/api-keys/get-api-key.md): Returns details and permissions for the specified API key. This endpoint requires an account-level API key. - [POST /api-keys/rotate](https://api-docs.solidgate.com/api/v2/api-keys/rotate-api-key.md): Rotates the secret key for the specified API key. Returns a new secret in the `rotate_secret` field, which becomes valid within a few seconds. The previous secret remains valid during the rotation per ## Channels - [POST /channels/list](https://api-docs.solidgate.com/api/v2/channels/list-channel.md): Retrieves a paginated list of channels for the specified account. This endpoint requires an account-level API key. ## Legal entities - [POST /legal-entities/list](https://api-docs.solidgate.com/api/v2/legal-entities/list-legal-entities.md): Retrieves a paginated list of legal entities registered under your account. This endpoint requires an account-level API key. - [POST /legal-entities/get](https://api-docs.solidgate.com/api/v2/legal-entities/get-legal-entity.md): Retrieves details for the specified legal entity registered under your account. This endpoint requires an account-level API key. ## Webhooks - [POST /webhooks/create](https://api-docs.solidgate.com/api/v2/webhooks/create-webhook.md): Creates a new webhook endpoint to receive payment and order events. Webhook endpoints are inactive until activated by calling the patch endpoint with the status set to ACTIVE. - [POST /webhooks/list](https://api-docs.solidgate.com/api/v2/webhooks/list-webhook.md): Retrieves a paginated list of webhook endpoints. - [POST /webhooks/get](https://api-docs.solidgate.com/api/v2/webhooks/get-webhook.md): Retrieves webhook endpoint details by ID. - [POST /webhooks/patch](https://api-docs.solidgate.com/api/v2/webhooks/patch-webhook.md): Updates an existing webhook endpoint configuration. To stop account-level events on a webhook with a channel filter, set `is_account_events_enabled` to `false` and send `event_types` without account-l - [POST /webhooks/delete](https://api-docs.solidgate.com/api/v2/webhooks/delete-webhook.md): Deletes a webhook endpoint. - [POST /webhooks/rotate-key](https://api-docs.solidgate.com/api/v2/webhooks/rotate-webhook-key.md): Rotates the secret for the specified webhook key. Returns a new secret in the `rotate_secret` field, which becomes valid within a few seconds. The previous secret remains valid during the rotation per ## Customers - [POST /customers/create](https://api-docs.solidgate.com/api/v2/customers/create-customer.md): Creates a new customer. - [POST /customers/update](https://api-docs.solidgate.com/api/v2/customers/update-customer.md): Updates specified customer fields. - [POST /customers/get](https://api-docs.solidgate.com/api/v2/customers/get-customer.md): Returns the customer for the provided identifier. - [POST /customers/list](https://api-docs.solidgate.com/api/v2/customers/list-customers.md): Returns a paginated list of customers. - [POST CustomerCreated](https://api-docs.solidgate.com/api/v2/customers/on-customer-created.md): Webhook sent when a new customer is created. - [POST CustomerUpdated](https://api-docs.solidgate.com/api/v2/customers/on-customer-updated.md): Webhook sent when a customer is updated. ## Payment instruments - [POST /payment-instruments/get](https://api-docs.solidgate.com/api/v2/payment-instruments/get-payment-instrument.md): Returns the payment instrument for the provided identifier. - [POST /payment-instruments/list](https://api-docs.solidgate.com/api/v2/payment-instruments/list-payment-instruments.md): Returns a paginated list of payment instruments for the specified customer. - [POST /payment-instruments/revoke](https://api-docs.solidgate.com/api/v2/payment-instruments/revoke-payment-instrument.md): Revokes an active payment instrument and prevents it from being used for future payments. - [POST PaymentInstrumentCreated](https://api-docs.solidgate.com/api/v2/payment-instruments/on-payment-instrument-created.md): Webhook sent when a new payment instrument is created. - [POST PaymentInstrumentRevoked](https://api-docs.solidgate.com/api/v2/payment-instruments/on-payment-instrument-revoked.md): Webhook sent when a payment instrument is revoked. - [POST PaymentInstrumentExpired](https://api-docs.solidgate.com/api/v2/payment-instruments/on-payment-instrument-expired.md): Webhook sent when a payment instrument expires. ## Invoices - [POST /invoices/create](https://api-docs.solidgate.com/api/v2/invoices/create-invoice.md): Creates a new invoice. - [POST /invoices/update](https://api-docs.solidgate.com/api/v2/invoices/update-invoice.md): Updates specified fields of a draft invoice. - [POST /invoices/finalize](https://api-docs.solidgate.com/api/v2/invoices/finalize-invoice.md): Finalizes a draft invoice. - [POST /invoices/void](https://api-docs.solidgate.com/api/v2/invoices/void-invoice.md): Voids an unpaid invoice. - [POST /invoices/delete](https://api-docs.solidgate.com/api/v2/invoices/delete-invoice.md): Deletes a draft invoice. - [POST /invoices/get](https://api-docs.solidgate.com/api/v2/invoices/get-invoice.md): Returns the invoice for the provided identifier. - [POST /invoices/list](https://api-docs.solidgate.com/api/v2/invoices/list-invoices.md): Returns a paginated list of invoices. Results can briefly lag behind recent changes. To get the current state of an invoice, use get invoice. - [POST /invoices/pay](https://api-docs.solidgate.com/api/v2/invoices/pay-invoice.md): Pays a finalized invoice using a saved payment instrument. - [POST InvoiceCreated](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-created.md): Webhook sent when a new invoice is created. - [POST InvoiceUpdated](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-updated.md): Webhook sent when an invoice is updated. - [POST InvoiceFinalized](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-finalized.md): Webhook sent when an invoice is finalized. - [POST InvoiceFinalizationFailed](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-finalization-failed.md): Webhook sent when an invoice finalization fails. - [POST InvoicePaid](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-paid.md): Webhook sent when an invoice is paid. - [POST InvoiceVoided](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-voided.md): Webhook sent when an invoice is voided. - [POST InvoiceDeleted](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-deleted.md): Webhook sent when an invoice is deleted. - [POST InvoicePaymentFailed](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-payment-failed.md): Webhook sent when an invoice payment fails. - [POST InvoiceDunningStarted](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-dunning-started.md): Webhook sent when an invoice enters the dunning process. - [POST InvoiceUnpaid](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-unpaid.md): Webhook sent when an invoice becomes unpaid. ## Subscriptions - [POST /subscriptions/create](https://api-docs.solidgate.com/api/v2/subscriptions/create-subscription.md): Creates a new subscription. - [POST /subscriptions/get](https://api-docs.solidgate.com/api/v2/subscriptions/get-subscription.md): Returns the subscription for the provided identifier. - [POST /subscriptions/list](https://api-docs.solidgate.com/api/v2/subscriptions/list-subscriptions.md): Returns a paginated list of subscriptions. Results can briefly lag behind recent changes. To get the current state of a subscription, use get subscription. - [POST /subscriptions/search](https://api-docs.solidgate.com/api/v2/subscriptions/search-subscriptions.md): Returns a paginated list of subscriptions that match the specified filters, ordered newest first. Results are eventually consistent, so new and updated records are not immediately searchable. Do not u - [POST /subscriptions/cancel](https://api-docs.solidgate.com/api/v2/subscriptions/cancel-subscription.md): Cancels the subscription immediately or schedules cancellation for the end of the current billing period. - [POST /subscriptions/delete-cancellation](https://api-docs.solidgate.com/api/v2/subscriptions/delete-subscription-cancellation.md): Removes the cancellation scheduled for the end of the current billing period by the subscription cancel operation with mode `PERIOD_END`, keeping the subscription active. - [POST /subscriptions/update](https://api-docs.solidgate.com/api/v2/subscriptions/update-subscription.md): Applies targeted updates to an active subscription, including updating the payment instrument, discount, description, and metadata, ending a trial period, and managing line items. For example, trial e - [POST SubscriptionCreated](https://api-docs.solidgate.com/api/v2/subscriptions/on-subscription-created.md): Webhook sent when a new subscription is created. - [POST SubscriptionUpdated](https://api-docs.solidgate.com/api/v2/subscriptions/on-subscription-updated.md): Webhook sent when a subscription is updated. - [POST SubscriptionScheduledForCancellation](https://api-docs.solidgate.com/api/v2/subscriptions/on-subscription-scheduled-for-cancellation.md): Webhook sent when a subscription is scheduled for cancellation. - [POST SubscriptionCancelled](https://api-docs.solidgate.com/api/v2/subscriptions/on-subscription-cancelled.md): Webhook sent when a subscription is cancelled. - [POST SubscriptionTrialActivated](https://api-docs.solidgate.com/api/v2/subscriptions/on-subscription-trial-activated.md): Webhook sent when a subscription trial is activated. - [POST SubscriptionActivated](https://api-docs.solidgate.com/api/v2/subscriptions/on-subscription-activated.md): Webhook sent when a subscription is activated. - [POST SubscriptionExpired](https://api-docs.solidgate.com/api/v2/subscriptions/on-subscription-expired.md): Webhook sent when a subscription expires. - [POST SubscriptionRedemptionStarted](https://api-docs.solidgate.com/api/v2/subscriptions/on-subscription-redemption-started.md): Webhook sent when a subscription redemption period is started. - [POST SubscriptionUnpaid](https://api-docs.solidgate.com/api/v2/subscriptions/on-subscription-unpaid.md): Webhook sent when a subscription becomes unpaid after exhausting retry attempts. - [POST SubscriptionRenewed](https://api-docs.solidgate.com/api/v2/subscriptions/on-subscription-renewed.md): Webhook sent when a subscription is renewed. ## Antifraud lists - [POST /antifraud-lists/create](https://api-docs.solidgate.com/api/v2/antifraud-lists/create-antifraud-list.md): Creates a new antifraud list. - [POST /antifraud-lists/update](https://api-docs.solidgate.com/api/v2/antifraud-lists/update-antifraud-list.md): Updates the antifraud list. - [POST /antifraud-lists/list](https://api-docs.solidgate.com/api/v2/antifraud-lists/list-antifraud-list.md): Retrieves a paginated list of antifraud lists. - [POST /antifraud-lists/get](https://api-docs.solidgate.com/api/v2/antifraud-lists/get-antifraud-list.md): Returns the antifraud list for the provided identifier. - [POST /antifraud-lists/create-item](https://api-docs.solidgate.com/api/v2/antifraud-lists/create-item-antifraud-list.md): Creates a new antifraud list item. - [POST /antifraud-lists/delete-item](https://api-docs.solidgate.com/api/v2/antifraud-lists/delete-item-antifraud-list.md): Deletes the antifraud list item for the provided identifier. - [POST /antifraud-lists/list-item](https://api-docs.solidgate.com/api/v2/antifraud-lists/list-item-antifraud-list.md): Retrieves a paginated list of antifraud list items. ## Antifraud results - [POST AntifraudResultCreated](https://api-docs.solidgate.com/api/v2/antifraud-results/on-antifraud-result-created.md): Webhook sent when an antifraud result is created for a payment. ## Fraud alerts - [POST FraudAlertReceived](https://api-docs.solidgate.com/api/v2/fraud-alerts/on-fraud-alert-received.md): Webhook sent when a fraud alert is received for a payment. ## Prevention alerts - [POST PreventionAlertReceived](https://api-docs.solidgate.com/api/v2/prevention-alerts/on-prevention-alert-received.md): Webhook sent when a prevention alert is received for a payment. ## Routing - [POST /routing-configs/get](https://api-docs.solidgate.com/api/v2/routing/get-routing-config.md): Returns the routing configuration for the provided identifier. - [POST /routing-configs/get-version](https://api-docs.solidgate.com/api/v2/routing/get-routing-config-version.md): Returns the routing configuration version with the full route tree for the provided identifier. - [POST /routing-configs/list](https://api-docs.solidgate.com/api/v2/routing/list-routing-configs.md): Returns a paginated list of routing configurations. - [POST RoutingConfigVersionPublished](https://api-docs.solidgate.com/api/v2/routing/on-routing-config-version-published.md): Webhook sent when a new routing configuration version is published. ## Connector accounts - [POST /connector-accounts/list](https://api-docs.solidgate.com/api/v2/connector-accounts/list-connector-accounts.md): Retrieves a paginated list of connector accounts registered under your account, newest first. This endpoint requires an account-level API key. - [POST /connector-accounts/get](https://api-docs.solidgate.com/api/v2/connector-accounts/get-connector-account.md): Retrieves details for the specified connector account registered under your account. This endpoint requires an account-level API key. - [POST /connector-accounts/list-descriptors](https://api-docs.solidgate.com/api/v2/connector-accounts/list-connector-account-descriptors.md): Retrieves a paginated list of dynamic descriptors of the specified connector account, newest first. For a connector account with the `STATIC` descriptor type, the list is empty. This endpoint requires ## Settlements - [POST /settlements/list](https://api-docs.solidgate.com/api/v2/settlements/list-settlements.md): Retrieves a paginated list of settlements. This endpoint requires an account-level API key. - [POST /settlements/get](https://api-docs.solidgate.com/api/v2/settlements/get-settlement.md): Retrieves details for the specified settlement. This endpoint requires an account-level API key. ## Monthly statements - [POST /monthly-statements/list](https://api-docs.solidgate.com/api/v2/monthly-statements/list-monthly-statements.md): Retrieves a paginated list of monthly statements. This endpoint requires an account-level API key. - [POST /monthly-statements/get](https://api-docs.solidgate.com/api/v2/monthly-statements/get-monthly-statement.md): Retrieves details for the specified monthly statement. This endpoint requires an account-level API key. ## Financial invoices - [POST /financial-invoices/list](https://api-docs.solidgate.com/api/v2/financial-invoices/list-financial-invoices.md): Retrieves a paginated list of financial invoices. This endpoint requires an account-level API key. - [POST /financial-invoices/get](https://api-docs.solidgate.com/api/v2/financial-invoices/get-financial-invoice.md): Retrieves details for the specified financial invoice. This endpoint requires an account-level API key. ## Reports - [POST /reports/create](https://api-docs.solidgate.com/api/v2/reports/create-report.md): Creates a report for the specified date range. The report is processed asynchronously. Once processing completes, use the returned `id` to download it. - [POST /reports/get](https://api-docs.solidgate.com/api/v2/reports/get-report.md): Returns the report for the provided identifier in its current status. The response includes a report only if the API key has access to it. Poll this endpoint after creating a report to track processin - [POST /reports/download](https://api-docs.solidgate.com/api/v2/reports/download-report.md): Returns a 303 redirect to a short-lived download URL. - [POST /reports/list](https://api-docs.solidgate.com/api/v2/reports/list-reports.md): Returns reports available to the current API key, sorted by creation date (newest first). The response includes only report types the API key has access to. Supports cursor-based pagination. - [POST ReportGenerated](https://api-docs.solidgate.com/api/v2/reports/on-report-generated.md): Webhook sent when a report finishes generating and is ready to download.