# Solidgate API Reference Solidgate API v2 simplifies payment integration with consistent REST conventions.

OpenAPI specification

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

YA ML YAML JSON

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.

php PHP JS Node.js Go Kotlin Python

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

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: SECRET ### signatureAuth Base64-encoded HMAC-SHA256 of the raw request body, computed with the webhook endpoint's secret key. Type: apiKey In: header Name: Signature ## Download OpenAPI description [Solidgate API Reference](https://api-docs.solidgate.com/_bundle/api/@v2/index.yaml) ## API keys Create, list, retrieve, and rotate API keys so you can securely authenticate requests and control access to the API. ### Create API key - [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. ### List API keys - [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. ### Get 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. ### Rotate 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 period and expires once the period ends. This endpoint requires an account-level API key. ## Channels List the channels available to your account so you can use them in API operations, such as configuring API keys. ### List 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. ## Webhooks Create, list, patch, delete, and retrieve webhook endpoints, manage secret keys, and receive events when customer or invoice records change. ### Create webhook - [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. ### List webhooks - [POST /webhooks/list](https://api-docs.solidgate.com/api/v2/webhooks/list-webhook.md): Retrieves a paginated list of webhook endpoints. ### Get webhook - [POST /webhooks/get](https://api-docs.solidgate.com/api/v2/webhooks/get-webhook.md): Retrieves webhook endpoint details by ID. ### Patch webhook - [POST /webhooks/patch](https://api-docs.solidgate.com/api/v2/webhooks/patch-webhook.md): Updates an existing webhook endpoint configuration. ### Delete webhook - [POST /webhooks/delete](https://api-docs.solidgate.com/api/v2/webhooks/delete-webhook.md): Deletes a webhook endpoint. ### Rotate webhook key - [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 period and expires once the period ends. ## Customers Create, update, and retrieve customer records to keep data consistent across payments and billing. ### Create customer - [POST /customers/create](https://api-docs.solidgate.com/api/v2/customers/create-customer.md): Creates a new customer. ### Update customer - [POST /customers/patch](https://api-docs.solidgate.com/api/v2/customers/patch-customer.md): Updates specified customer fields. ### Get customer - [POST /customers/get](https://api-docs.solidgate.com/api/v2/customers/get-customer.md): Returns the customer for the provided identifier. ### List customers - [POST /customers/list](https://api-docs.solidgate.com/api/v2/customers/list-customers.md): Returns a paginated list of customers. ### Customer created - [POST CustomerCreated](https://api-docs.solidgate.com/api/v2/customers/on-customer-created.md): Webhook sent when a new customer is created. ### Customer updated - [POST CustomerUpdated](https://api-docs.solidgate.com/api/v2/customers/on-customer-updated.md): Webhook sent when a customer is updated. ## Payment instruments List, retrieve, and revoke customer payment instruments and receive events when payment instruments change. ### Get payment instrument - [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. ### List payment instruments - [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. ### Revoke payment instrument - [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. ### Payment instrument created - [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. ### Payment instrument revoked - [POST PaymentInstrumentRevoked](https://api-docs.solidgate.com/api/v2/payment-instruments/on-payment-instrument-revoked.md): Webhook sent when a payment instrument is revoked. ### Payment instrument expired - [POST PaymentInstrumentExpired](https://api-docs.solidgate.com/api/v2/payment-instruments/on-payment-instrument-expired.md): Webhook sent when a payment instrument expires. ## Invoices Create, update, finalize, void, pay using a saved payment instrument, and retrieve invoices to issue and track billing for your customers. ### Create invoice - [POST /invoices/create](https://api-docs.solidgate.com/api/v2/invoices/create-invoice.md): Creates a new invoice. ### Patch invoice - [POST /invoices/patch](https://api-docs.solidgate.com/api/v2/invoices/patch-invoice.md): Updates specified fields of a draft invoice. ### Finalize invoice - [POST /invoices/finalize](https://api-docs.solidgate.com/api/v2/invoices/finalize-invoice.md): Finalizes a draft invoice. ### Void invoice - [POST /invoices/void](https://api-docs.solidgate.com/api/v2/invoices/void-invoice.md): Voids an unpaid invoice. ### Delete invoice - [POST /invoices/delete](https://api-docs.solidgate.com/api/v2/invoices/delete-invoice.md): Deletes a draft invoice. ### Get invoice - [POST /invoices/get](https://api-docs.solidgate.com/api/v2/invoices/get-invoice.md): Returns the invoice for the provided identifier. ### List invoices - [POST /invoices/list](https://api-docs.solidgate.com/api/v2/invoices/list-invoices.md): Returns a paginated list of invoices. ### Pay invoice - [POST /invoices/pay](https://api-docs.solidgate.com/api/v2/invoices/pay-invoice.md): Pays a finalized invoice using a saved payment instrument. ### Invoice created - [POST InvoiceCreated](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-created.md): Webhook sent when a new invoice is created. ### Invoice updated - [POST InvoiceUpdated](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-updated.md): Webhook sent when an invoice is updated. ### Invoice finalized - [POST InvoiceFinalized](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-finalized.md): Webhook sent when an invoice is finalized. ### Invoice finalization failed - [POST InvoiceFinalizationFailed](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-finalization-failed.md): Webhook sent when an invoice finalization fails. ### Invoice paid - [POST InvoicePaid](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-paid.md): Webhook sent when an invoice is paid. ### Invoice voided - [POST InvoiceVoided](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-voided.md): Webhook sent when an invoice is voided. ### Invoice deleted - [POST InvoiceDeleted](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-deleted.md): Webhook sent when an invoice is deleted. ### Invoice payment failed - [POST InvoicePaymentFailed](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-payment-failed.md): Webhook sent when an invoice payment fails. ### Invoice payment refunded - [POST InvoicePaymentRefunded](https://api-docs.solidgate.com/api/v2/invoices/on-invoice-payment-refunded.md): Webhook sent when an invoice payment is refunded. ## Antifraud lists Manage lists and items to allow or block transactions and reduce chargebacks and fraud. ### Create antifraud list - [POST /antifraud-lists/create](https://api-docs.solidgate.com/api/v2/antifraud-lists/create-antifraud-list.md): Creates a new antifraud list. ### Update antifraud list - [POST /antifraud-lists/update](https://api-docs.solidgate.com/api/v2/antifraud-lists/update-antifraud-list.md): Updates the antifraud list. ### List antifraud lists - [POST /antifraud-lists/list](https://api-docs.solidgate.com/api/v2/antifraud-lists/list-antifraud-list.md): Retrieves a paginated list of antifraud lists. ### Get antifraud list - [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. ### Create antifraud list item - [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. ### Delete 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. ### List antifraud list items - [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.