# Grid API Documentation > The Grid API enables modern financial institutions to easily send and receive global payments. The following documentation helps developers understand the Grid API and how to integrate with it. ## Docs - [](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/index.md) - [What is Grid?](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/introduction/what-is-grid.md) - [Capabilities](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/capabilities.md) - [Use Cases](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/use-cases.md): Discover what you can build with Grid - [Building with AI](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/building-with-ai.md): Use AI coding assistants like Claude Code, Cursor, and Codex to explore, build, and debug with the Grid API - [FAQ](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/introduction/faq.md) - [Entities & Relationships](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/core-concepts/entities.md): Understanding Grid's core data model - [Quote System](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/core-concepts/quote-system.md): How exchange rates, pricing, and payment execution work - [Account Model](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/core-concepts/account-model.md): Internal accounts, external accounts, and how they work together - [Transaction Lifecycle](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/core-concepts/transaction-lifecycle.md): Follow a payment from creation to settlement - [Currencies & Payment Rails](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/core-concepts/currencies-and-rails.md): Supported currencies, countries, and payment methods - [Configuration](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/platform-overview/configuration.md): Configure your Grid integration - [Build your flow](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/flow-builder.md): Design your flow and get the API calls for your exact use case - [Global Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-accounts/index.md): Give your customers a branded, self-custody dollar account powered by Grid. - [Implementation overview](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-accounts/implementation-overview.md): End-to-end walkthrough: create a customer, find their Global Account, register a passkey, fund the account, and execute a signed withdrawal. - [Authentication](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-accounts/authentication.md): Register, reauthenticate, and manage Global Account credentials (passkey, OAuth, email OTP) - [Client keys & signing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-accounts/client-keys.md): Generate the P-256 client key pair, decrypt the session signing key, and sign account actions on Web, iOS, and Android - [Sessions](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-accounts/managing-sessions.md): List and revoke active sessions on a Global Account - [Exporting a wallet](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-accounts/exporting-wallet.md): Let a customer take the seed of their Global Account off Grid - [Webhooks](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-accounts/platform-tools/webhooks.md): Receive webhook events for funding, withdrawals, and other account state changes on Global Accounts - [Sandbox testing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-accounts/platform-tools/sandbox-testing.md): Exercise the Global Account auth, signing, and funding flows without standing up real OTP delivery, WebAuthn, or OIDC providers - [Postman Collection](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-accounts/platform-tools/postman-collection.md): Explore the Grid API for Global Accounts using the published Postman collection - [Payouts & B2B](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/index.md) - [Core Concepts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/terminology.md): Core concepts and terminology for the Grid API - [Implementation Overview](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/onboarding/implementation-overview.md) - [Quickstart](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/quickstart.md): Send your first cross-border payment - [Platform Configuration](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/onboarding/platform-configuration.md): Configuring credentials, webhooks and currencies for your platform - [Configuring Customers](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/onboarding/configuring-customers.md): Configuring customers for Payouts - [Internal Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/depositing-funds/internal-accounts.md): Learn how to manage internal accounts for holding platform and customer funds - [External Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/depositing-funds/external-accounts.md): Add and manage external bank accounts, wallets, and payment destinations for withdrawals and payouts - [Depositing Funds](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/depositing-funds/depositing-funds.md): Depositing funds into internal accounts - [Sending Payments](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/payment-flow/send-payment.md): Learn how to send payments from internal accounts to external bank accounts with same-currency and cross-currency transfers - [List Transactions](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/payment-flow/list-transactions.md): Query and filter payment history with powerful filtering and pagination options - [Reconciliation](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/payment-flow/reconciliation.md): Match Grid transactions with your internal systems - [Error Handling](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/payment-flow/error-handling.md): Handle payment failures, API errors, and transaction issues gracefully - [Global Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/global-accounts/overview.md): Self-custody stablecoin accounts that plug into Grid payment flows - [Client keys & signing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/global-accounts/client-keys.md): Generate the P-256 client key pair, decrypt the session signing key, and sign account actions on Web, iOS, and Android - [Authentication](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/global-accounts/authentication.md): Register, reauthenticate, and manage Global Account credentials (passkey, OAuth, email OTP) - [Sessions](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/global-accounts/managing-sessions.md): List and revoke active sessions on a Global Account - [Exporting a wallet](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/global-accounts/exporting-wallet.md): Let a customer take the seed of their Global Account off Grid - [Webhooks](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/platform-tools/webhooks.md) - [Sandbox Testing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/platform-tools/sandbox-testing.md): Test your payouts integration in the Grid sandbox environment - [Postman Collection](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/payouts-and-b2b/platform-tools/postman-collection.md) - [Ramps](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/index.md) - [Core Concepts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/terminology.md): Core concepts and terminology for the Grid API - [Implementation Overview](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/onboarding/implementation-overview.md) - [Quickstart](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/quickstart.md): Complete guide for converting fiat to crypto (on-ramp) and delivering Bitcoin to a Spark wallet - [Platform Configuration](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/onboarding/platform-configuration.md) - [Configuring Customers](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/onboarding/configuring-customers.md): Create and manage customers for ramp conversions - [Internal Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/accounts/internal-accounts.md): Manage internal accounts for holding fiat and crypto balances for ramp operations - [External Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/accounts/external-accounts.md): Configure external bank accounts and crypto wallets for ramp destinations - [Depositing Funds](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/accounts/depositing-funds.md): Depositing funds into internal accounts - [Fiat-to-Crypto and Crypto-to-Fiat](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/conversion-flows/fiat-crypto-conversion.md): Build on-ramp and off-ramp flows to convert between fiat currencies and cryptocurrencies - [Self-Custody Wallet Integration](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/conversion-flows/self-custody-wallets.md): Send and receive cryptocurrency to and from user-controlled wallets - [Global Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/global-accounts/overview.md): Self-custody stablecoin accounts that plug into Grid payment flows - [Client keys & signing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/global-accounts/client-keys.md): Generate the P-256 client key pair, decrypt the session signing key, and sign account actions on Web, iOS, and Android - [Authentication](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/global-accounts/authentication.md): Register, reauthenticate, and manage Global Account credentials (passkey, OAuth, email OTP) - [Sessions](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/global-accounts/managing-sessions.md): List and revoke active sessions on a Global Account - [Exporting a wallet](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/global-accounts/exporting-wallet.md): Let a customer take the seed of their Global Account off Grid - [Webhooks](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/platform-tools/webhooks.md): Receive real-time notifications for ramp conversions, account updates, and transaction status - [Sandbox Testing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/platform-tools/sandbox-testing.md): Test ramp flows safely without moving real funds - [Postman Collection](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/ramps/platform-tools/postman-collection.md) - [Rewards](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/index.md) - [Core Concepts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/terminology.md): Core concepts and terminology for the Grid API - [Implementation Overview](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/developer-guides/implementation-overview.md) - [Quickstart](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/quickstart.md): Complete walkthrough for buying Bitcoin and sending it as a reward to an external Spark wallet for self-custody - [Platform Configuration](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/developer-guides/platform-configuration.md): Configuring platform settings for rewards - [Internal Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/developer-guides/internal-accounts.md): Learn how to manage and fund internal accounts for holding platform and customer funds - [External Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/developer-guides/external-accounts.md): Add and manage external funding sources and wallets as payment destinations for rewards - [Paying out Bitcoin rewards](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/developer-guides/distributing-rewards.md): Send Bitcoin rewards to customers using the Grid API - [Listing Transactions](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/developer-guides/listing-transactions.md): Query and track Bitcoin reward payment history with filtering and pagination - [Global Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/global-accounts/overview.md): Self-custody stablecoin accounts that plug into Grid payment flows - [Client keys & signing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/global-accounts/client-keys.md): Generate the P-256 client key pair, decrypt the session signing key, and sign account actions on Web, iOS, and Android - [Authentication](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/global-accounts/authentication.md): Register, reauthenticate, and manage Global Account credentials (passkey, OAuth, email OTP) - [Sessions](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/global-accounts/managing-sessions.md): List and revoke active sessions on a Global Account - [Exporting a wallet](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/global-accounts/exporting-wallet.md): Let a customer take the seed of their Global Account off Grid - [Webhooks](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/platform-tools/webhooks.md) - [Sandbox Testing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/platform-tools/sandbox-testing.md): Test your rewards integration in the Grid sandbox environment - [Postman Collection](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/rewards/platform-tools/postman-collection.md) - [Global P2P](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/index.md) - [Core Concepts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/terminology.md): Core concepts and terminology for the Grid API - [Implementation Overview](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/getting-started/implementation-overview.md): High-level implementation plan for configuring, onboarding, funding, and moving money - [Quickstart](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/quickstart.md): Send your first cross-border payment - [Platform Configuration](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/getting-started/platform-configuration.md): Configuring credentials, webhooks and currencies for your platform global P2P payments - [Configuring Customers](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/onboarding/configuring-customers.md): Creating and managing customers for global P2P payments - [Invitations](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/onboarding/invitations.md) - [Internal Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/managing-accounts/internal-accounts.md): Create and manage internal accounts - [External Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/managing-accounts/external-accounts.md): Register and manage beneficiary bank accounts - [Depositing Funds](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/sending-receiving-payments/depositing-funds.md): Depositing funds into internal accounts - [Sending Payments](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/sending-receiving-payments/sending-payments.md) - [Receiving Payments](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/sending-receiving-payments/receiving-payments.md): Receiving payments from UMA addresses - [Reconciliation](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/sending-receiving-payments/reconciliation.md): Reconciliation of payments - [Error Handling](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/sending-receiving-payments/error-handling.md): Handle payment failures, API errors, and transaction issues in Global P2P - [Global Accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/global-accounts/overview.md): Self-custody stablecoin accounts that plug into Grid payment flows - [Client keys & signing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/global-accounts/client-keys.md): Generate the P-256 client key pair, decrypt the session signing key, and sign account actions on Web, iOS, and Android - [Authentication](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/global-accounts/authentication.md): Register, reauthenticate, and manage Global Account credentials (passkey, OAuth, email OTP) - [Sessions](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/global-accounts/managing-sessions.md): List and revoke active sessions on a Global Account - [Exporting a wallet](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/global-accounts/exporting-wallet.md): Let a customer take the seed of their Global Account off Grid - [Webhooks](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/platform-tools/webhooks.md): Security best practices for webhook verification - [Sandbox Testing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/platform-tools/sandbox-testing.md) - [Postman Collection](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/platform-tools/postman-collection.md) - [UMA Test Wallet](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/global-p2p/platform-tools/uma-test-wallet.md): Test UMA payment flows with a real counterparty - [Environments](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/environments.md) - [Core Concepts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/terminology.md): Core concepts and terminology for the Grid API - [Authentication](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/authentication.md) - [Webhooks](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/webhooks.md): Learn how to receive and verify webhook notifications from the Grid API - [Sandbox Testing](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/sandbox-testing.md): Use Grid sandbox magic values to trigger specific API responses - [SDKs & CLI](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/sdks.md): Official client libraries and command-line interface for the Grid API - [Get platform configuration](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/platform-configuration/get-platform-configuration.md): Retrieve the current platform configuration - [Update platform configuration](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/platform-configuration/update-platform-configuration.md): Update the platform configuration settings - [Get exchange rates](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/exchange-rates/get-exchange-rates.md): Retrieve cached exchange rates for currency corridors. Returns FX rates that are cached for approximately 5 minutes. Rates include fees specific to your platform for authenticated requests. - [List available receiving institution names](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/discoveries/list-available-receiving-institution-names.md): Retrieve available payment institution names for a given country and currency. Use this endpoint to look up supported banks and payment providers for a specific corridor. If no country and currency parameter are provided, all payment institutions will be returned - [List customers](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/customers/list-customers.md): Retrieve a list of customers with optional filtering parameters. Returns all customers that match the specified filters. If no filters are provided, returns all customers (paginated). - [Add a new customer](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/customers/add-a-new-customer.md): Register a new customer in the system with an account identifier and bank account information - [Get customer by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/customers/get-customer-by-id.md): Retrieve a customer by their system-generated ID - [Delete customer by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/customers/delete-customer-by-id.md): Delete a customer by their system-generated ID - [Update customer by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/customers/update-customer-by-id.md): Update a customer's metadata by their system-generated ID - [Upload customers via CSV file](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/customers/upload-customers-via-csv-file.md): Upload a CSV file containing customer information for bulk creation. The CSV file should follow a specific format with required and optional columns based on customer type. - [Get bulk import job status](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/customers/get-bulk-import-job-status.md): Retrieve the current status and results of a bulk customer import job. This endpoint can be used to track the progress of both CSV uploads. - [Get a KYC link for onboarding a customer](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/kyckyb-verifications/get-a-kyc-link-for-onboarding-a-customer.md): Generate a hosted KYC link to onboard a customer - [List beneficial owners](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/kyckyb-verifications/list-beneficial-owners.md): Retrieve a list of beneficial owners for a business customer. - [Create a beneficial owner](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/kyckyb-verifications/create-a-beneficial-owner.md): Add a beneficial owner, director, or company officer to a business customer. The beneficial owner will go through KYC verification automatically. - [Get a beneficial owner](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/kyckyb-verifications/get-a-beneficial-owner.md): Retrieve details of a specific beneficial owner by ID. - [Update a beneficial owner](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/kyckyb-verifications/update-a-beneficial-owner.md): Update details of a specific beneficial owner. Only provided fields are updated. - [List verifications](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/kyckyb-verifications/list-verifications.md): Retrieve a list of verifications with optional filtering by customer ID and status. - [Submit customer for verification](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/kyckyb-verifications/submit-customer-for-verification.md): Trigger KYC (individual) or KYB (business) verification for a customer. The response indicates whether all required information has been provided. If data is missing, the `errors` array describes exactly what needs to be supplied before verification can proceed. - [Get a verification](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/kyckyb-verifications/get-a-verification.md): Retrieve details of a specific verification by ID. - [List Customer internal accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/internal-accounts/list-customer-internal-accounts.md): Retrieve a list of internal accounts with optional filtering parameters. Returns all internal accounts that match the specified filters. If no filters are provided, returns all internal accounts (paginated). - [List platform internal accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/internal-accounts/list-platform-internal-accounts.md): Retrieve a list of all internal accounts that belong to the platform, as opposed to an individual customer. - [Export internal account wallet credentials](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/internal-accounts/export-internal-account-wallet-credentials.md): Export the wallet credentials of an Embedded Wallet internal account. The returned wallet credentials are HPKE-encrypted to the `clientPublicKey` supplied in the request body. - [List Customer external accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/external-accounts/list-customer-external-accounts.md): Retrieve a list of external accounts with optional filtering parameters. Returns all external accounts that match the specified filters. If no filters are provided, returns all external accounts (paginated). - [Add a new external account](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/external-accounts/add-a-new-external-account.md): Register a new external bank account for a customer. - [Get customer external account by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/external-accounts/get-customer-external-account-by-id.md): Retrieve a customer external account by its system-generated ID - [Delete customer external account by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/external-accounts/delete-customer-external-account-by-id.md): Delete a customer external account by its system-generated ID - [List platform external accounts](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/external-accounts/list-platform-external-accounts.md): Retrieve a list of all external accounts that belong to the platform, as opposed to an individual customer. - [Add a new platform external account](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/external-accounts/add-a-new-platform-external-account.md): Register a new external bank account for the platform. - [Get platform external account by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/external-accounts/get-platform-external-account-by-id.md): Retrieve a platform external account by its system-generated ID - [Delete platform external account by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/external-accounts/delete-platform-external-account-by-id.md): Delete a platform external account by its system-generated ID - [List documents](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/documents/list-documents.md): Retrieve a list of documents with optional filtering by document holder. - [Upload a document](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/documents/upload-a-document.md): Upload a verification document for a customer or beneficial owner. The request must use multipart/form-data with the file in the `file` field and metadata in the remaining fields. - [Get a document by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/documents/get-a-document-by-id.md): Retrieve details and metadata of a specific document by ID. - [Replace a document](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/documents/replace-a-document.md): Replace an existing document with a new file and/or updated metadata. This is useful when a document was rejected and needs to be re-uploaded. The request must use multipart/form-data. - [Delete a document](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/documents/delete-a-document.md): Delete an uploaded document. This cannot be undone. Documents that have already been submitted for verification may not be deletable. - [Create a transfer-in request](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/same-currency-transfers/create-a-transfer-in-request.md): Transfer funds from an external account to an internal account for a specific customer. This endpoint should only be used for external account sources with pull functionality (e.g. ACH Pull). Otherwise, use the paymentInstructions on the internal account to deposit funds. - [Create a transfer-out request](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/same-currency-transfers/create-a-transfer-out-request.md): Transfer funds from an internal account to an external account for a specific customer. - [Look up an UMA address for payment](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/cross-currency-transfers/look-up-an-uma-address-for-payment.md): Lookup a receiving UMA address to determine supported currencies and exchange rates. This endpoint helps platforms determine what currencies they can send to a given UMA address. - [Look up an external account for payment](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/cross-currency-transfers/look-up-an-external-account-for-payment.md): Lookup an external account by ID to determine supported currencies and exchange rates. This endpoint helps platforms determine what currencies they can send to a given external account, along with the current estimated exchange rates and minimum and maximum amounts that can be sent. - [Get quote by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/cross-currency-transfers/get-quote-by-id.md): Retrieve a quote by its ID. If the quote has been settled, it will include the transaction ID. This allows clients to track the full lifecycle of a payment from quote creation to settlement. - [Create a transfer quote](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/cross-currency-transfers/create-a-transfer-quote.md): Generate a quote for a cross-currency transfer between any combination of accounts and UMA addresses. This endpoint handles currency exchange and provides the necessary instructions to execute the transfer. - [Execute a quote](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/cross-currency-transfers/execute-a-quote.md): Execute a quote by its ID. This endpoint initiates the transfer between the source and destination accounts. - [Estimate crypto withdrawal fee](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/cross-currency-transfers/estimate-crypto-withdrawal-fee.md): Estimate the network and application fees for a cryptocurrency withdrawal from a crypto internal account to an external blockchain address. Use this to show fee information to customers before they initiate a withdrawal. - [List transactions](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/transactions/list-transactions.md): Retrieve a paginated list of transactions with optional filtering. The transactions can be filtered by customer ID, platform customer ID, UMA address, date range, status, and transaction type. - [Get transaction by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/transactions/get-transaction-by-id.md): Retrieve detailed information about a specific transaction. - [Approve a pending incoming payment](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/transactions/approve-a-pending-incoming-payment.md): Approve a pending incoming payment that was previously acknowledged with a 202 response. This endpoint allows platforms to asynchronously approve payments after async processing. - [Reject a pending incoming payment](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/transactions/reject-a-pending-incoming-payment.md): Reject a pending incoming payment that was previously acknowledged with a 202 response. This endpoint allows platforms to asynchronously reject payments after additional processing. - [Send a test webhook](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/sandbox/send-a-test-webhook.md): Send a test webhook to the configured endpoint - [Simulate sending funds](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/sandbox/simulate-sending-funds.md): Simulate sending funds to the bank account as instructed in the quote. This endpoint is only for the sandbox environment and will fail for production platforms/keys. - [Simulate payment send to test receiving an UMA payment](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/sandbox/simulate-payment-send-to-test-receiving-an-uma-payment.md): Simulate sending payment from an sandbox uma address to a platform customer to test payment receive. This endpoint is only for the sandbox environment and will fail for production platforms/keys. - [Simulate funding an internal account](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/sandbox/simulate-funding-an-internal-account.md): Simulate receiving funds into an internal account in the sandbox environment. This is useful for testing scenarios where you need to add funds to a customer's or platform's internal account without going through a real bank transfer or following payment instructions. This endpoint is only for the sa… - [Create an UMA invitation](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/invitations/create-an-uma-invitation.md): Create an UMA invitation from a given platform customer. - [Get an UMA invitation by code](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/invitations/get-an-uma-invitation-by-code.md): Retrieve details about an UMA invitation by its invitation code. - [Claim an UMA invitation](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/invitations/claim-an-uma-invitation.md): Claim an UMA invitation by associating it with an invitee UMA address. - [Cancel an UMA invitation](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/invitations/cancel-an-uma-invitation.md): Cancel a pending UMA invitation. Only the inviter or platform can cancel an invitation. - [List available Counterparty Providers](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/available-uma-providers/list-available-counterparty-providers.md): Retrieve a list of available Counterparty Providers. The response includes basic information about each provider, such as its UMA address, name, and supported currencies. - [List tokens](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/api-tokens/list-tokens.md): Retrieve a list of API tokens with optional filtering parameters. Returns all tokens that match the specified filters. If no filters are provided, returns all tokens (paginated). - [Create a new API token](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/api-tokens/create-a-new-api-token.md): Create a new API token to access the Grid APIs. - [Get API token by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/api-tokens/get-api-token-by-id.md): Retrieve an API token by their system-generated ID - [Delete API token by ID](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/api-tokens/delete-api-token-by-id.md): Delete an API token by their system-generated ID - [List authentication credentials](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/embedded-wallet-auth/list-authentication-credentials.md): Retrieve all authentication credentials registered on an Embedded Wallet internal account. - [Create an authentication credential](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/embedded-wallet-auth/create-an-authentication-credential.md): Register an authentication credential for an Embedded Wallet customer. - [Revoke an authentication credential](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/embedded-wallet-auth/revoke-an-authentication-credential.md): Revoke an authentication credential on an Embedded Wallet internal account. - [Verify an authentication credential](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/embedded-wallet-auth/verify-an-authentication-credential.md): Complete the verification step for a previously created authentication credential and issue a session signing key. - [Re-issue an authentication credential challenge](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/embedded-wallet-auth/re-issue-an-authentication-credential-challenge.md): Re-issue the challenge for an existing authentication credential. - [List active sessions](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/embedded-wallet-auth/list-active-sessions.md): Retrieve all active authentication sessions on an Embedded Wallet internal account. A session is created each time a credential is verified via `POST /auth/credentials/{id}/verify`, and remains active until its `expiresAt` passes or it is revoked via `DELETE /auth/sessions/{id}`. - [Revoke an authentication session](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/embedded-wallet-auth/revoke-an-authentication-session.md): Revoke an authentication session on an Embedded Wallet internal account. Revocation is a two-step signed-retry flow: - [Incoming payment webhook and approval mechanism](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/webhooks/incoming-payment-webhook-and-approval-mechanism.md): Webhook that is called when an incoming payment is received by a customer's UMA address. This endpoint should be implemented by clients of the Grid API. - [Outgoing payment status webhook](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/webhooks/outgoing-payment-status-webhook.md): Webhook that is called when an outgoing payment's status changes. This endpoint should be implemented by clients of the Grid API. - [Test webhook for integration verification](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/webhooks/test-webhook-for-integration-verification.md): Webhook that is sent once to verify your webhook endpoint is correctly set up. This is sent when you configure or update your platform settings with a webhook URL. - [Bulk upload status webhook](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/webhooks/bulk-upload-status-webhook.md): Webhook that is called when a bulk customer upload job completes or fails. This endpoint should be implemented by clients of the Grid API. - [Invitation claimed webhook](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/webhooks/invitation-claimed-webhook.md): Webhook that is called when an invitation is claimed by a customer. This endpoint should be implemented by platform clients of the Grid API. - [Customer status change](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/webhooks/customer-status-change.md): Webhook that is called when the status of a customer is updated, including KYC and KYB status changes. This endpoint should be implemented by clients of the Grid API. - [Internal account status webhook](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/webhooks/internal-account-status-webhook.md): Webhook that is called when the status of an internal account changes. This includes balance updates and may include additional account events in the future. This endpoint should be implemented by clients of the Grid API. - [Verification status change](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/api-reference/webhooks/verification-status-change.md): Webhook that is called when a customer's KYC/KYB verification status changes. This endpoint should be implemented by clients of the Grid API. ## OpenAPI Specs - [openapi.documented](https://app.stainless.com/api/spec/documented/grid/openapi.documented.yml) - [openapi](https://ramps-04-30-docs-add-grid-tutorial-skill-interactive-zero-t.mintlify.site/openapi.yaml)