# Paymnt Cloud Docs

## Docs

- [3DS Decision - Execute](https://docs.paymnt.cloud/api-reference/3ds-decision-rule/3ds-decision--execute.md)
- [API Key - Create](https://docs.paymnt.cloud/api-reference/api-key/api-key--create.md): Create a new API Key for accessing our APIs from your servers. The plaintext API Key will be displayed only once on creation, so ensure you store it securely.
- [API Key - List](https://docs.paymnt.cloud/api-reference/api-key/api-key--list.md): List all the API Keys associated to a merchant account.
- [API Key - Retrieve](https://docs.paymnt.cloud/api-reference/api-key/api-key--retrieve.md): Retrieve information about the specified API Key.
- [API Key - Revoke](https://docs.paymnt.cloud/api-reference/api-key/api-key--revoke.md): Revoke the specified API Key. Once revoked, the API Key can no longer be used for authenticating with our APIs.
- [API Key - Update](https://docs.paymnt.cloud/api-reference/api-key/api-key--update.md): Update information for the specified API Key.
- [Authentication - Create](https://docs.paymnt.cloud/api-reference/authentication/authentication--create.md): Create a new authentication for accessing our APIs from your servers.
- [Delete blocklist](https://docs.paymnt.cloud/api-reference/blocklist/delete-blocklist.md)
- [Get blocklist](https://docs.paymnt.cloud/api-reference/blocklist/get-blocklist.md)
- [Post blocklist](https://docs.paymnt.cloud/api-reference/blocklist/post-blocklist.md)
- [Post blocklisttoggle](https://docs.paymnt.cloud/api-reference/blocklist/post-blocklisttoggle.md)
- [Customers - Create](https://docs.paymnt.cloud/api-reference/customers/customers--create.md): Creates a customer object and stores the customer details to be reused for future payments. Incase the customer already exists in the system, this API will respond with the customer details.
- [Customers - Delete](https://docs.paymnt.cloud/api-reference/customers/customers--delete.md): Delete a customer record.
- [Customers - List](https://docs.paymnt.cloud/api-reference/customers/customers--list.md): Lists all the customers for a particular merchant id.
- [Customers - Retrieve](https://docs.paymnt.cloud/api-reference/customers/customers--retrieve.md): Retrieves a customer's details.
- [Customers - Update](https://docs.paymnt.cloud/api-reference/customers/customers--update.md): Updates the customer's details in a customer object.
- [Disputes - List Disputes](https://docs.paymnt.cloud/api-reference/disputes/disputes--list-disputes.md): Lists all the Disputes for a merchant
- [Disputes - Retrieve Dispute](https://docs.paymnt.cloud/api-reference/disputes/disputes--retrieve-dispute.md): Retrieves a dispute
- [Events - Delivery Attempt List](https://docs.paymnt.cloud/api-reference/event/events--delivery-attempt-list.md): List all delivery attempts for the specified Event.
- [Events - List](https://docs.paymnt.cloud/api-reference/event/events--list.md): List all Events associated with a Merchant Account or Profile.
- [Events - List](https://docs.paymnt.cloud/api-reference/event/events--list-1.md): List all Events associated with a Profile.
- [Events - Manual Retry](https://docs.paymnt.cloud/api-reference/event/events--manual-retry.md): Manually retry the delivery of the specified Event.
- [Gsm - Create](https://docs.paymnt.cloud/api-reference/gsm/gsm--create.md): Creates a GSM (Global Status Mapping) Rule. A GSM rule is used to map a connector's error message/error code combination during a particular payments flow/sub-flow to PaymntCloud's unified status/error code/error message combination. It is also used to decide the next action in the flow - retry/requ…
- [Gsm - Delete](https://docs.paymnt.cloud/api-reference/gsm/gsm--delete.md): Deletes a Gsm Rule
- [Gsm - Get](https://docs.paymnt.cloud/api-reference/gsm/gsm--get.md): Retrieves a Gsm Rule
- [Gsm - Update](https://docs.paymnt.cloud/api-reference/gsm/gsm--update.md): Updates a Gsm Rule
- [Mandates - Customer Mandates List](https://docs.paymnt.cloud/api-reference/mandates/mandates--customer-mandates-list.md): Lists all the mandates for a particular customer id.
- [Mandates - Retrieve Mandate](https://docs.paymnt.cloud/api-reference/mandates/mandates--retrieve-mandate.md): Retrieves a mandate created using the Payments/Create API
- [Mandates - Revoke Mandate](https://docs.paymnt.cloud/api-reference/mandates/mandates--revoke-mandate.md): Revokes a mandate created using the Payments/Create API
- [Merchant Account - Create](https://docs.paymnt.cloud/api-reference/merchant-account/merchant-account--create.md): Create a new account for a *merchant* and the *merchant* could be a seller or retailer or client who likes to receive and send payments.
- [Merchant Account - Delete](https://docs.paymnt.cloud/api-reference/merchant-account/merchant-account--delete.md): Delete a *merchant* account
- [Merchant Account - KV Status](https://docs.paymnt.cloud/api-reference/merchant-account/merchant-account--kv-status.md): Toggle KV mode for the Merchant Account
- [Merchant Account - Retrieve](https://docs.paymnt.cloud/api-reference/merchant-account/merchant-account--retrieve.md): Retrieve a *merchant* account details.
- [Merchant Account - Update](https://docs.paymnt.cloud/api-reference/merchant-account/merchant-account--update.md): Updates details of an existing merchant account. Helpful in updating merchant details such as email, contact details, or other configuration details like webhook, routing algorithm etc
- [Merchant Connector - Create](https://docs.paymnt.cloud/api-reference/merchant-connector-account/merchant-connector--create.md): Creates a new Merchant Connector for the merchant account. The connector could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting etc.
- [Merchant Connector - Delete](https://docs.paymnt.cloud/api-reference/merchant-connector-account/merchant-connector--delete.md): Delete or Detach a Merchant Connector from Merchant Account
- [Merchant Connector - List](https://docs.paymnt.cloud/api-reference/merchant-connector-account/merchant-connector--list.md): List Merchant Connector Details for the merchant
- [Merchant Connector - Retrieve](https://docs.paymnt.cloud/api-reference/merchant-connector-account/merchant-connector--retrieve.md): Retrieves details of a Connector account
- [Merchant Connector - Update](https://docs.paymnt.cloud/api-reference/merchant-connector-account/merchant-connector--update.md): To update an existing Merchant Connector account. Helpful in enabling/disabling different payment methods and other settings for the connector
- [Organization - Create](https://docs.paymnt.cloud/api-reference/organization/organization--create.md): Create a new organization
- [Organization - Retrieve](https://docs.paymnt.cloud/api-reference/organization/organization--retrieve.md): Retrieve an existing organization
- [Organization - Update](https://docs.paymnt.cloud/api-reference/organization/organization--update.md): Create a new organization for .
- [List customer saved payment methods for a Payment](https://docs.paymnt.cloud/api-reference/payment-methods/list-customer-saved-payment-methods-for-a-payment.md): Lists all the applicable payment methods for a particular payment tied to the `client_secret`.
- [List payment methods for a Customer](https://docs.paymnt.cloud/api-reference/payment-methods/list-payment-methods-for-a-customer.md): Lists all the applicable payment methods for a particular Customer ID.
- [List payment methods for a Merchant](https://docs.paymnt.cloud/api-reference/payment-methods/list-payment-methods-for-a-merchant.md): Lists the applicable payment methods for a particular Merchant ID. Use the client secret and publishable key authorization to list all relevant payment methods of the merchant for the payment corresponding to the client secret.
- [Payment Method - Delete](https://docs.paymnt.cloud/api-reference/payment-methods/payment-method--delete.md): Deletes a payment method of a customer.
- [Payment Method - Retrieve](https://docs.paymnt.cloud/api-reference/payment-methods/payment-method--retrieve.md): Retrieves a payment method of a customer.
- [Payment Method - Set Default Payment Method for Customer](https://docs.paymnt.cloud/api-reference/payment-methods/payment-method--set-default-payment-method-for-customer.md): Set the Payment Method as Default for the Customer.
- [Payment Method - Update](https://docs.paymnt.cloud/api-reference/payment-methods/payment-method--update.md): Update an existing payment method of a customer. This API is useful for use cases such as updating the card number for expired cards to prevent discontinuity in recurring payments.
- [PaymentMethods - Create](https://docs.paymnt.cloud/api-reference/payment-methods/paymentmethods--create.md): Creates and stores a payment method against a customer. In case of cards, this API should be used only by PCI compliant merchants.
- [Payments - Cancel](https://docs.paymnt.cloud/api-reference/payments/payments--cancel.md): A Payment could can be cancelled when it is in one of these statuses: `requires_payment_method`, `requires_capture`, `requires_confirmation`, `requires_customer_action`.
- [Payments - Cancel Post Capture](https://docs.paymnt.cloud/api-reference/payments/payments--cancel-post-capture.md): A Payment could can be cancelled when it is in one of these statuses: `succeeded`, `partially_captured`, `partially_captured_and_capturable`.
- [Payments - Capture](https://docs.paymnt.cloud/api-reference/payments/payments--capture.md): Captures the funds for a previously authorized payment intent where `capture_method` was set to `manual` and the payment is in a `requires_capture` state.
- [Payments - Complete Authorize](https://docs.paymnt.cloud/api-reference/payments/payments--complete-authorize.md)
- [Payments - Confirm](https://docs.paymnt.cloud/api-reference/payments/payments--confirm.md): Confirms a payment intent that was previously created with `confirm: false`. This action attempts to authorize the payment with the payment processor.
- [Payments - Create](https://docs.paymnt.cloud/api-reference/payments/payments--create.md): Creates a payment resource, which represents a customer's intent to pay. This endpoint is the starting point for various payment flows:
- [Payments - External 3DS Authentication](https://docs.paymnt.cloud/api-reference/payments/payments--external-3ds-authentication.md): External 3DS Authentication is performed and returns the AuthenticationResponse
- [Payments - Incremental Authorization](https://docs.paymnt.cloud/api-reference/payments/payments--incremental-authorization.md): Authorized amount for a payment can be incremented if it is in status: requires_capture
- [Payments - List](https://docs.paymnt.cloud/api-reference/payments/payments--list.md): To list the *payments*
- [Payments - Post Session Tokens](https://docs.paymnt.cloud/api-reference/payments/payments--post-session-tokens.md)
- [Payments - Retrieve](https://docs.paymnt.cloud/api-reference/payments/payments--retrieve.md): Retrieves a Payment. This API can also be used to get the status of a previously initiated payment or next action for an ongoing payment
- [Payments - Session token](https://docs.paymnt.cloud/api-reference/payments/payments--session-token.md): Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by PaymntCloud's SDK to initiate these wallets' SDK.
- [Payments - Update](https://docs.paymnt.cloud/api-reference/payments/payments--update.md): To update the properties of a *PaymentIntent* object. This may include attaching a payment method, or attaching customer object or metadata fields after the Payment is created
- [Payments - Update Metadata](https://docs.paymnt.cloud/api-reference/payments/payments--update-metadata.md)
- [Payments Link - Retrieve](https://docs.paymnt.cloud/api-reference/payments/payments-link--retrieve.md): To retrieve the properties of a Payment Link. This may be used to get the status of a previously initiated payment or next action for an ongoing payment
- [Payouts - Cancel](https://docs.paymnt.cloud/api-reference/payouts/payouts--cancel.md)
- [Payouts - Confirm](https://docs.paymnt.cloud/api-reference/payouts/payouts--confirm.md)
- [Payouts - Create](https://docs.paymnt.cloud/api-reference/payouts/payouts--create.md)
- [Payouts - Fulfill](https://docs.paymnt.cloud/api-reference/payouts/payouts--fulfill.md)
- [Payouts - List](https://docs.paymnt.cloud/api-reference/payouts/payouts--list.md)
- [Payouts - List available filters](https://docs.paymnt.cloud/api-reference/payouts/payouts--list-available-filters.md)
- [Payouts - List using filters](https://docs.paymnt.cloud/api-reference/payouts/payouts--list-using-filters.md)
- [Payouts - Retrieve](https://docs.paymnt.cloud/api-reference/payouts/payouts--retrieve.md)
- [Payouts - Update](https://docs.paymnt.cloud/api-reference/payouts/payouts--update.md)
- [Platform - Create](https://docs.paymnt.cloud/api-reference/platform/platform--create.md): Create a new platform account
- [Poll - Retrieve Poll Status](https://docs.paymnt.cloud/api-reference/poll/poll--retrieve-poll-status.md)
- [Profile Acquirer - Create](https://docs.paymnt.cloud/api-reference/profile-acquirer/profile-acquirer--create.md): Create a new Profile Acquirer for accessing our APIs from your servers.
- [Profile Acquirer - Update](https://docs.paymnt.cloud/api-reference/profile-acquirer/profile-acquirer--update.md): Update a Profile Acquirer for accessing our APIs from your servers.
- [Profile - Create](https://docs.paymnt.cloud/api-reference/profile/profile--create.md): Creates a new *profile* for a merchant
- [Profile - Delete](https://docs.paymnt.cloud/api-reference/profile/profile--delete.md): Delete the *profile*
- [Profile - List](https://docs.paymnt.cloud/api-reference/profile/profile--list.md): Lists all the *profiles* under a merchant
- [Profile - Retrieve](https://docs.paymnt.cloud/api-reference/profile/profile--retrieve.md): Retrieve existing *profile*
- [Profile - Update](https://docs.paymnt.cloud/api-reference/profile/profile--update.md): Update the *profile*
- [Refunds - Create](https://docs.paymnt.cloud/api-reference/refunds/refunds--create.md): Creates a refund against an already processed payment. In case of some processors, you can even opt to refund only a partial amount multiple times until the original charge amount has been refunded
- [Refunds - List](https://docs.paymnt.cloud/api-reference/refunds/refunds--list.md): Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided
- [Refunds - Retrieve](https://docs.paymnt.cloud/api-reference/refunds/refunds--retrieve.md): Retrieves a Refund. This may be used to get the status of a previously initiated refund
- [Refunds - Update](https://docs.paymnt.cloud/api-reference/refunds/refunds--update.md): Updates the properties of a Refund object. This API can be used to attach a reason for the refund or metadata fields
- [Relay - Create](https://docs.paymnt.cloud/api-reference/relay/relay--create.md): Creates a relay request.
- [Relay - Retrieve](https://docs.paymnt.cloud/api-reference/relay/relay--retrieve.md): Retrieves a relay details.
- [Routing - Activate config](https://docs.paymnt.cloud/api-reference/routing/routing--activate-config.md): Activate a routing config
- [Routing - Create](https://docs.paymnt.cloud/api-reference/routing/routing--create.md): Create a routing config
- [Routing - Deactivate](https://docs.paymnt.cloud/api-reference/routing/routing--deactivate.md): Deactivates a routing config
- [Routing - Evaluate](https://docs.paymnt.cloud/api-reference/routing/routing--evaluate.md): Evaluate routing rules
- [Routing - Feedback](https://docs.paymnt.cloud/api-reference/routing/routing--feedback.md): Update gateway scores for dynamic routing
- [Routing - List](https://docs.paymnt.cloud/api-reference/routing/routing--list.md): List all routing configs
- [Routing - Retrieve](https://docs.paymnt.cloud/api-reference/routing/routing--retrieve.md): Retrieve a routing algorithm
- [Routing - Retrieve Config](https://docs.paymnt.cloud/api-reference/routing/routing--retrieve-config.md): Retrieve active config
- [Routing - Retrieve Default Config](https://docs.paymnt.cloud/api-reference/routing/routing--retrieve-default-config.md): Retrieve default fallback config
- [Routing - Retrieve Default For Profile](https://docs.paymnt.cloud/api-reference/routing/routing--retrieve-default-for-profile.md): Retrieve default config for profiles
- [Routing - Rule Evaluate](https://docs.paymnt.cloud/api-reference/routing/routing--rule-evaluate.md): Evaluate routing rules
- [Routing - Toggle Contract routing for profile](https://docs.paymnt.cloud/api-reference/routing/routing--toggle-contract-routing-for-profile.md): Create a Contract based dynamic routing algorithm
- [Routing - Toggle elimination routing for profile](https://docs.paymnt.cloud/api-reference/routing/routing--toggle-elimination-routing-for-profile.md): Create a elimination based dynamic routing algorithm
- [Routing - Toggle success based dynamic routing for profile](https://docs.paymnt.cloud/api-reference/routing/routing--toggle-success-based-dynamic-routing-for-profile.md): Create a success based dynamic routing algorithm
- [Routing - Update contract based dynamic routing config for profile](https://docs.paymnt.cloud/api-reference/routing/routing--update-contract-based-dynamic-routing-config-for-profile.md): Update contract based dynamic routing algorithm
- [Routing - Update Default Config](https://docs.paymnt.cloud/api-reference/routing/routing--update-default-config.md): Update default fallback config
- [Routing - Update Default For Profile](https://docs.paymnt.cloud/api-reference/routing/routing--update-default-for-profile.md): Update default config for profiles
- [Routing - Update success based dynamic routing config for profile](https://docs.paymnt.cloud/api-reference/routing/routing--update-success-based-dynamic-routing-config-for-profile.md): Update success based dynamic routing algorithm
- [Welcome to Paymnt Cloud](https://docs.paymnt.cloud/intro.md): Paymnt Cloud is a unified payments orchestration layer with smart routing and full-lifecycle tooling.
- [Environments](https://docs.paymnt.cloud/pages/environments.md): Paymnt Cloud provides two fully isolated environments
- [Authentication](https://docs.paymnt.cloud/pages/essentials/authentication.md): How to authenticate with Paymnt Cloud API
- [Error Codes](https://docs.paymnt.cloud/pages/essentials/error-codes.md): Understanding Paymnt Cloud error responses
- [Idempotency](https://docs.paymnt.cloud/pages/essentials/idempotency.md): Safe retry patterns with idempotency keys
- [Pagination & Filtering](https://docs.paymnt.cloud/pages/essentials/pagination-filtering.md): How to paginate and filter API responses
- [Rate Limits](https://docs.paymnt.cloud/pages/essentials/rate-limits.md): API rate limits and best practices
- [Customers — Overview](https://docs.paymnt.cloud/pages/guides/customers/overview.md): Managing customer data and relationships
- [Tokens & Vault](https://docs.paymnt.cloud/pages/guides/customers/tokens-vault.md): Tokenization and secure vault management
- [Dispute Evidence](https://docs.paymnt.cloud/pages/guides/disputes/evidence.md): Collecting and submitting dispute evidence
- [Disputes — Overview](https://docs.paymnt.cloud/pages/guides/disputes/overview.md): Understanding dispute management and lifecycle
- [3DS & SCA](https://docs.paymnt.cloud/pages/guides/payments/3ds-sca.md): Strong Customer Authentication and 3D Secure flows
- [Capture & Void](https://docs.paymnt.cloud/pages/guides/payments/capture-void.md): How to capture or void authorized payments
- [Create a Payment](https://docs.paymnt.cloud/pages/guides/payments/create.md): How to create payments with Paymnt Cloud
- [Payments — Overview](https://docs.paymnt.cloud/pages/guides/payments/overview.md): Understanding payment flows in Paymnt Cloud
- [Payment Methods](https://docs.paymnt.cloud/pages/guides/payments/payment-methods.md): Supported payment methods and their requirements
- [Refunds from a Payment](https://docs.paymnt.cloud/pages/guides/payments/refunds.md): How to process refunds for payments
- [Create & List Refunds](https://docs.paymnt.cloud/pages/guides/refunds/create-list.md): Creating and managing refunds
- [Refunds — Overview](https://docs.paymnt.cloud/pages/guides/refunds/overview.md): Understanding refund flows and requirements
- [Changelog](https://docs.paymnt.cloud/pages/operations/changelog.md): API changes and release notes
- [Observability](https://docs.paymnt.cloud/pages/operations/observability.md): Monitoring, logging, and alerting
- [Retries & Backoff](https://docs.paymnt.cloud/pages/operations/retries-backoff.md): Recommended retry policies and error handling
- [Connectors](https://docs.paymnt.cloud/pages/platform/connectors.md): Overview of payment connectors and capabilities
- [Profiles](https://docs.paymnt.cloud/pages/platform/profiles.md): Multi-profile configuration for routing and fees
- [Reconciliation & Reporting](https://docs.paymnt.cloud/pages/platform/reconciliation-reporting.md): Data aggregation, settlement reports, and analytics
- [Smart Routing](https://docs.paymnt.cloud/pages/platform/routing.md): Intelligent payment routing and optimization
- [Quickstart](https://docs.paymnt.cloud/pages/quickstart.md): This guide shows the minimal flow to create a payment, optionally confirm/capture it, and issue a refund using **Paymnt Cloud**.
- [JavaScript SDK](https://docs.paymnt.cloud/pages/sdks/js.md): Client-side integration with Paymnt Cloud
- [Postman & CLI](https://docs.paymnt.cloud/pages/sdks/postman-cli.md): Testing with Postman collections and command line tools
- [Server SDKs](https://docs.paymnt.cloud/pages/sdks/server.md): Server-side SDKs for various programming languages
- [GDPR & PII](https://docs.paymnt.cloud/pages/security/gdpr-pii.md): Data protection and privacy compliance
- [PCI Scope](https://docs.paymnt.cloud/pages/security/pci.md): PCI DSS compliance and scope reduction
- [RBAC & Keys](https://docs.paymnt.cloud/pages/security/rbac-keys.md): Role-based access control and key management
- [Contact & Support](https://docs.paymnt.cloud/pages/support/contact.md): How to get help and contact support
- [FAQ](https://docs.paymnt.cloud/pages/support/faq.md): Frequently asked questions
- [Sandbox](https://docs.paymnt.cloud/pages/testing/sandbox.md): Testing environment and features
- [Test Cards & 3DS](https://docs.paymnt.cloud/pages/testing/test-cards-3ds.md): Test card numbers and 3D Secure scenarios
- [Event Types](https://docs.paymnt.cloud/pages/webhooks/event-types.md): Catalog of webhook events and payloads
- [Webhooks — Overview](https://docs.paymnt.cloud/pages/webhooks/overview.md): Event-driven integration with webhooks
- [Signing & Retries](https://docs.paymnt.cloud/pages/webhooks/signing-retries.md): Webhook signature verification and retry handling

## OpenAPI Specs

- [openapi](https://docs.paymnt.cloud/public/openapi.json)
- [openapi_spec_v2](https://docs.paymnt.cloud/pages/_imported_hs/v2/openapi_spec_v2.json)
- [openapi_spec_v1](https://docs.paymnt.cloud/pages/_imported_hs/v1/openapi_spec_v1.json)
- [rust_locker_open_api_spec](https://docs.paymnt.cloud/pages/_imported_hs/rust_locker_open_api_spec.yml)
- [hyperswitch_intelligent_router_open_api_spec](https://docs.paymnt.cloud/pages/_imported_hs/hyperswitch_intelligent_router_open_api_spec.yml)
- [openapi_v2](https://docs.paymnt.cloud/openapi_v2.json)
- [openapi_v1](https://docs.paymnt.cloud/openapi_v1.json)

## Optional

- [Dashboard](https://dash.paymnt.cloud)
- [Support](mailto:support@paymnt.cloud)