# Gnosis Ramp API Guide

## Docs

- [Get supported currency pairs](https://docs.ramp.gnosis.io/api-reference/endpoints/currencies/get-supported-currency-pairs.md): Retrieve the list of supported currency pairs and their available providers.
- [Create customer](https://docs.ramp.gnosis.io/api-reference/endpoints/customers/create-customer.md): Create a new customer or retrieve an existing one.
- [Get all customers](https://docs.ramp.gnosis.io/api-reference/endpoints/customers/get-all-customers.md): Retrieve a list of all customers for the authenticated project.
- [Create payment intent](https://docs.ramp.gnosis.io/api-reference/endpoints/intents/create-payment-intent.md): Create a new payment intent with inline source and destination account data.
- [Execute transaction for payment intent](https://docs.ramp.gnosis.io/api-reference/endpoints/intents/execute-transaction-for-payment-intent.md): Initiates provider transaction execution for an intent. The underlying Temporal workflow processes this transaction asynchronously.
- [Get all payment intents](https://docs.ramp.gnosis.io/api-reference/endpoints/intents/get-all-payment-intents.md): Retrieve all payment intents for the authenticated customer
- [Get indicative quote](https://docs.ramp.gnosis.io/api-reference/endpoints/intents/get-indicative-quote.md): Retrieve indicative pricing from multiple providers before creating an intent.
- [Get intent requirements](https://docs.ramp.gnosis.io/api-reference/endpoints/intents/get-intent-requirements.md): Retrieve JSON Schema requirements for the source and destination account data needed to create an intent for a currency pair.
- [Get payment intent](https://docs.ramp.gnosis.io/api-reference/endpoints/intents/get-payment-intent.md): Retrieve details of a specific payment intent by ID
- [Get transaction for payment intent](https://docs.ramp.gnosis.io/api-reference/endpoints/intents/get-transaction-for-payment-intent.md): Retrieve the current transaction status and deposit instructions for an intent.
- [Get all providers](https://docs.ramp.gnosis.io/api-reference/endpoints/providers/get-all-providers.md): Retrieve the list of all active providers available for the authenticated project.
- [API Reference](https://docs.ramp.gnosis.io/api-reference/overview.md): Navigate the OpenAPI spec and authentication models.
- [Creating a Customer](https://docs.ramp.gnosis.io/customers/creating-customer.md): Create a customer to perform ramp operations on their behalf.
- [Creating a Customer with External Auth](https://docs.ramp.gnosis.io/customers/creating-customer-with-external-auth.md): Use Gnosispay SIWE authentication to enable KYC sharing and faster compliance.
- [Amount Formatting](https://docs.ramp.gnosis.io/intents/amount-formatting.md): Understand decimal precision and amount formatting requirements.
- [Creating an Intent](https://docs.ramp.gnosis.io/intents/creating-intent.md): Create an intent to start a ramp operation.
- [Currencies & Providers](https://docs.ramp.gnosis.io/intents/currencies-providers.md): Discover available currency pairs and ramp providers.
- [Executing Transactions](https://docs.ramp.gnosis.io/intents/executing-transactions.md): Trigger transaction execution after compliance approval.
- [Getting a Quote](https://docs.ramp.gnosis.io/intents/getting-quote.md): Retrieve indicative pricing from multiple providers before creating an intent.
- [Handling Compliance](https://docs.ramp.gnosis.io/intents/handling-compliance.md): Guide users through compliance requirements using the onboarding iframe.
- [Intents Overview](https://docs.ramp.gnosis.io/intents/overview.md): Understanding intents — the core concept for ramp operations.
- [Fetching Intent Requirements](https://docs.ramp.gnosis.io/intents/requirements.md): Use JSON Schema responses to validate source and destination account data before creating intents.
- [Transactions & Deposit Instructions](https://docs.ramp.gnosis.io/intents/transactions-deposits.md): Display deposit instructions and monitor transaction completion.
- [OFFRAMP: Crypto to Fiat](https://docs.ramp.gnosis.io/use-cases/offramp.md): Complete walkthrough for converting cryptocurrency to fiat currency.
- [ONRAMP: Fiat to Crypto](https://docs.ramp.gnosis.io/use-cases/onramp.md): Complete walkthrough for converting fiat currency to cryptocurrency.
- [Event Reference](https://docs.ramp.gnosis.io/webhooks/event-reference.md): Complete reference for all webhook event types and payloads.
- [Webhooks Overview](https://docs.ramp.gnosis.io/webhooks/overview.md): Receive real-time updates for intent and transaction status changes.
- [Signature Verification](https://docs.ramp.gnosis.io/webhooks/signature-verification.md): Verify webhook signatures to ensure requests are from Gnosis Ramp.
- [Authentication](https://docs.ramp.gnosis.io/welcome/authentication.md): How to authenticate requests to the Gnosis Ramp API.
- [Getting Started](https://docs.ramp.gnosis.io/welcome/getting-started.md): Set up your project and connect ramp providers in the Gnosis Ramp dashboard.
- [Gnosis Ramp Overview](https://docs.ramp.gnosis.io/welcome/overview.md): A unified API platform for regulated on/off ramp flows.

## OpenAPI Specs

- [openapi](https://docs.ramp.gnosis.io/openapi.yaml)