# 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

- [Approve an agent action](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/approve-an-agent-action.md): Approve a pending agent action, allowing Grid to proceed with execution. The action must have status `PENDING_APPROVAL`. Once approved, Grid executes the underlying operation (quote execution or transfer) and the action transitions to `APPROVED`. For `EXECUTE_QUOTE` actions, note that the underlying…
- [Create an agent](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/create-an-agent.md): Create a new agent with a specified policy. Returns the created agent and a device code that must be redeemed by the agent software to complete installation.
- [Delete agent](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/delete-agent.md): Permanently delete an agent. Connected agent software will lose access immediately.
- [Get agent by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/get-agent-by-id.md): Retrieve an agent by its system-generated ID.
- [Get device code status](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/get-device-code-status.md): Check whether a device code has been redeemed. Use this to poll for agent installation completion after creating an agent.
- [List agent transaction approval requests](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/list-agent-transaction-approval-requests.md): Retrieve a paginated list of agent actions that require platform approval. Filter by `agentId` or `customerId` to scope results to a specific agent or customer. Approve or reject individual actions via `POST /agents/{agentId}/actions/{actionId}/approve` or `POST /agents/{agentId}/actions/{actionId}/…
- [List agents](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/list-agents.md): Retrieve a paginated list of agents for the authenticated platform.
- [Redeem device code](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/redeem-device-code.md): Redeem a device code to obtain agent credentials. This endpoint is called by the agent software during installation. On success, returns a Bearer access token that the agent uses for all subsequent API calls. The token is returned only once and must be stored securely. This endpoint does not require…
- [Regenerate a device code](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/regenerate-a-device-code.md): Generate a new device code for an existing agent. Use this when the original device code has expired before being redeemed, or when the agent software needs to be reinstalled. Any previously issued unredeemed device codes for this agent are invalidated.
- [Reject an agent action](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/reject-an-agent-action.md): Reject a pending agent action, preventing execution. The action must have status `PENDING_APPROVAL`. Once rejected, the action transitions to `REJECTED` and the underlying operation is not executed. This endpoint is called by the platform's backend using platform credentials, not by the agent itself…
- [Update agent](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/update-agent.md): Update an agent's name or paused state.
- [Update agent policy](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-management/update-agent-policy.md): Partially update an agent's policy. Only provided fields will be updated; omitted fields retain their current values. Policy changes take effect immediately.
- [Add an external account](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/add-an-external-account.md): Register a new external bank account or wallet for the authenticated agent's customer. Requires the MANAGE_EXTERNAL_ACCOUNTS permission in the agent's policy. The `customerId` field is optional and will be inferred from the agent's associated customer if omitted.
- [Create a transfer-in](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/create-a-transfer-in.md): Transfer funds from an external account to an internal account for the authenticated agent's customer. Accounts must belong to the agent's customer. Requires the CREATE_TRANSFERS permission in the agent's policy. If the agent's policy requires approval for this amount, the transaction will be create…
- [Create a transfer-out](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/create-a-transfer-out.md): Transfer funds from an internal account to an external account for the authenticated agent's customer. Accounts must belong to the agent's customer. Requires the CREATE_TRANSFERS permission in the agent's policy. If the agent's policy requires approval for this amount, the transaction will be create…
- [Create a transfer quote](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/create-a-transfer-quote.md): Generate a quote for a cross-currency transfer on behalf of the authenticated agent's customer. Accounts referenced in the request must belong to the agent's customer. Requires the CREATE_QUOTES permission in the agent's policy. If the agent's defaultExecutionMode is APPROVAL_REQUIRED, or the quote…
- [Delete agent external account](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/delete-agent-external-account.md): Delete an external account belonging to the authenticated agent's customer. Requires the MANAGE_EXTERNAL_ACCOUNTS permission in the agent's policy.
- [Execute a quote](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/execute-a-quote.md): Execute a quote created by the authenticated agent. Requires the EXECUTE_QUOTES permission in the agent's policy. If the agent's policy requires approval for this amount (based on execution mode or approval thresholds), the transaction will be created in a pending state and must be approved by the p…
- [Get agent external account by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/get-agent-external-account-by-id.md): Retrieve an external account belonging to the authenticated agent's customer. Returns 404 if the account exists but belongs to a different customer. Requires the MANAGE_EXTERNAL_ACCOUNTS permission in the agent's policy.
- [Get agent quote by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/get-agent-quote-by-id.md): Retrieve a quote created by the authenticated agent. Returns 404 if the quote exists but was not created by this agent.
- [Get agent transaction by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/get-agent-transaction-by-id.md): Retrieve a specific transaction belonging to the authenticated agent's customer. Returns 404 if the transaction exists but belongs to a different customer.
- [Get an agent action](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/get-an-agent-action.md): Retrieve a specific action submitted by the authenticated agent. Poll this endpoint after submitting an action that requires approval to check whether it has been approved, rejected, or has failed.
- [Get current agent](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/get-current-agent.md): Retrieve the authenticated agent's own profile, policy, and current usage. This endpoint is called by the agent software itself using its own credentials (obtained via device code redemption) rather than platform credentials.
- [List agent external accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/list-agent-external-accounts.md): Retrieve a paginated list of external accounts belonging to the authenticated agent's customer. Requires the MANAGE_EXTERNAL_ACCOUNTS permission in the agent's policy.
- [List agent transactions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/list-agent-transactions.md): Retrieve a paginated list of transactions for the authenticated agent's customer. Results are automatically scoped to the agent's associated customer — no customer filter is needed or accepted.
- [List agent's internal accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/list-agents-internal-accounts.md): Retrieve the internal accounts belonging to the customer this agent operates on behalf of. Use this to discover available source accounts for transfers and quotes, and to verify which accounts are accessible under the agent's `accountRestrictions` policy.
- [List agent's own actions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/agent-operations/list-agents-own-actions.md): Retrieve a paginated list of actions submitted by the authenticated agent. Use this to poll for approval decisions after submitting an action that requires approval.
- [Create a new API token](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/api-tokens/create-a-new-api-token.md): Create a new API token to access the Grid APIs.
- [Delete API token by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/api-tokens/delete-api-token-by-id.md): Delete an API token by their system-generated ID
- [Get API token by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/api-tokens/get-api-token-by-id.md): Retrieve an API token by their system-generated ID
- [List tokens](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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).
- [Authentication](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/authentication.md)
- [List available Counterparty Providers](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Create a transfer quote](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Estimate crypto withdrawal fee](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Execute a quote](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Get quote by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Look up an external account for payment](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Look up an UMA address for payment](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Add a new customer](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/customers/add-a-new-customer.md): Register a new customer in the system with an account identifier and bank account information
- [Delete customer by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/customers/delete-customer-by-id.md): Delete a customer by their system-generated ID
- [Get bulk import job status](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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 customer by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/customers/get-customer-by-id.md): Retrieve a customer by their system-generated ID
- [List customers](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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).
- [Update customer by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [List available receiving institution names](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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
- [Delete a document](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Get a document by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/documents/get-a-document-by-id.md): Retrieve details and metadata of a specific document by ID.
- [List documents](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/documents/list-documents.md): Retrieve a list of documents with optional filtering by document holder.
- [Replace a document](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Upload a document](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Create an authentication credential](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/embedded-wallet-auth/create-an-authentication-credential.md): Register an authentication credential for an Embedded Wallet customer.
- [List active sessions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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}`.
- [List authentication credentials](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/embedded-wallet-auth/list-authentication-credentials.md): Retrieve all authentication credentials registered on an Embedded Wallet internal account.
- [Re-issue an authentication credential challenge](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/embedded-wallet-auth/re-issue-an-authentication-credential-challenge.md): Re-issue the challenge for an existing authentication credential.
- [Revoke an authentication credential](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/embedded-wallet-auth/revoke-an-authentication-credential.md): Revoke an authentication credential on an Embedded Wallet internal account.
- [Revoke an authentication session](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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:
- [Verify an authentication credential](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Environments](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/environments.md)
- [Get exchange rates](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Add a new external account](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/external-accounts/add-a-new-external-account.md): Register a new external bank account for a customer.
- [Add a new platform external account](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/external-accounts/add-a-new-platform-external-account.md): Register a new external bank account for the platform.
- [Delete customer external account by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/external-accounts/delete-customer-external-account-by-id.md): Delete a customer external account by its system-generated ID
- [Delete platform external account by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/external-accounts/delete-platform-external-account-by-id.md): Delete a platform external account by its system-generated ID
- [Get customer external account by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/external-accounts/get-customer-external-account-by-id.md): Retrieve a customer external account by its system-generated ID
- [Get platform external account by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/external-accounts/get-platform-external-account-by-id.md): Retrieve a platform external account by its system-generated ID
- [List Customer external accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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).
- [List platform external accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Export internal account wallet credentials](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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 internal accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Cancel an UMA invitation](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/invitations/cancel-an-uma-invitation.md): Cancel a pending UMA invitation. Only the inviter or platform can cancel an invitation.
- [Claim an UMA invitation](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/invitations/claim-an-uma-invitation.md): Claim an UMA invitation by associating it with an invitee UMA address.
- [Create an UMA invitation](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/invitations/get-an-uma-invitation-by-code.md): Retrieve details about an UMA invitation by its invitation code.
- [Create a beneficial owner](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/kyckyb-verifications/get-a-beneficial-owner.md): Retrieve details of a specific beneficial owner by ID.
- [Get a KYC link for onboarding a customer](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/kyckyb-verifications/get-a-kyc-link-for-onboarding-a-customer.md): Generate a hosted KYC link to onboard a customer
- [Get a verification](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/kyckyb-verifications/get-a-verification.md): Retrieve details of a specific verification by ID.
- [List beneficial owners](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/kyckyb-verifications/list-beneficial-owners.md): Retrieve a list of beneficial owners for a business customer.
- [List verifications](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Update a beneficial owner](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/kyckyb-verifications/update-a-beneficial-owner.md): Update details of a specific beneficial owner. Only provided fields are updated.
- [Get platform configuration](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/platform-configuration/get-platform-configuration.md): Retrieve the current platform configuration
- [Update platform configuration](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/platform-configuration/update-platform-configuration.md): Update the platform configuration settings
- [Create a transfer-in request](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Sandbox Testing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/sandbox-testing.md): Use Grid sandbox magic values to trigger specific API responses
- [Send a test webhook](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/sandbox/send-a-test-webhook.md): Send a test webhook to the configured endpoint
- [Simulate funding an internal account](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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…
- [Simulate payment send to test receiving an UMA payment](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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 sending funds](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [SDKs & CLI](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/sdks.md): Official client libraries and command-line interface for the Grid API
- [Core Concepts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/terminology.md): Core concepts and terminology for the Grid API
- [Approve a pending incoming payment](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Get transaction by ID](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/transactions/get-transaction-by-id.md): Retrieve detailed information about a specific transaction.
- [List transactions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Reject a pending incoming payment](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Webhooks](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/webhooks.md): Learn how to receive and verify webhook notifications from the Grid API
- [Agent action pending approval webhook](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/api-reference/webhooks/agent-action-pending-approval-webhook.md): Fired when an agent submits an action that requires platform approval before Grid will execute it. Use this to send a push notification to the customer so they can review and approve or reject the action in your app. This endpoint should be implemented by clients of the Grid API.
- [Bulk upload status webhook](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Customer status change](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Incoming payment webhook and approval mechanism](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Internal account status webhook](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Invitation claimed webhook](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Outgoing payment status webhook](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Verification status change](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Build your flow](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/flow-builder.md): Design your flow and get the API calls for your exact use case
- [Approvals & audit](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-accounts/agents/approvals-and-audit.md): Design approval, activity, and revoke experiences for agent-driven Global Account flows
- [Overview](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-accounts/agents/overview.md): Experimental native Grid functionality for connecting AI agents to Global Accounts with managed policy and approval flows
- [Policies & permissions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-accounts/agents/policies-and-permissions.md): Define bounded agent access for Global Accounts with permissions, limits, restrictions, and approval thresholds
- [Authentication](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-accounts/authentication.md): Register, reauthenticate, and manage Global Account credentials (passkey, OAuth, email OTP)
- [Client keys & signing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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
- [Exporting a wallet](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-accounts/exporting-wallet.md): Let a customer take the seed of their Global Account off Grid
- [Implementation overview](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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.
- [Global Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-accounts/index.md): Give your customers a branded, self-custody dollar account powered by Grid.
- [Sessions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-accounts/managing-sessions.md): List and revoke active sessions on a Global Account
- [Postman Collection](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-accounts/platform-tools/postman-collection.md): Explore the Grid API for Global Accounts using the published Postman collection
- [Sandbox testing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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
- [Webhooks](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-accounts/platform-tools/webhooks.md): Receive webhook events for funding, withdrawals, and other account state changes on Global Accounts
- [Implementation Overview](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/getting-started/implementation-overview.md): High-level implementation plan for configuring, onboarding, funding, and moving money
- [Platform Configuration](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/getting-started/platform-configuration.md): Configuring credentials, webhooks and currencies for your platform global P2P payments
- [Authentication](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/global-accounts/authentication.md): Register, reauthenticate, and manage Global Account credentials (passkey, OAuth, email OTP)
- [Client keys & signing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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
- [Exporting a wallet](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/global-accounts/exporting-wallet.md): Let a customer take the seed of their Global Account off Grid
- [Sessions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/global-accounts/managing-sessions.md): List and revoke active sessions on a Global Account
- [Global Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/global-accounts/overview.md): Self-custody stablecoin accounts that plug into Grid payment flows
- [Global P2P](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/index.md)
- [External Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/managing-accounts/external-accounts.md): Register and manage beneficiary bank accounts
- [Internal Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/managing-accounts/internal-accounts.md): Create and manage internal accounts
- [Configuring Customers](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/onboarding/configuring-customers.md): Creating and managing customers for global P2P payments
- [Invitations](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/onboarding/invitations.md)
- [Postman Collection](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/platform-tools/postman-collection.md)
- [Sandbox Testing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/platform-tools/sandbox-testing.md)
- [UMA Test Wallet](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/platform-tools/uma-test-wallet.md): Test UMA payment flows with a real counterparty
- [Webhooks](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/platform-tools/webhooks.md): Security best practices for webhook verification
- [Quickstart](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/quickstart.md): Send your first cross-border payment
- [Depositing Funds](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/sending-receiving-payments/depositing-funds.md): Depositing funds into internal accounts
- [Error Handling](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/sending-receiving-payments/error-handling.md): Handle payment failures, API errors, and transaction issues in Global P2P
- [Receiving Payments](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/sending-receiving-payments/receiving-payments.md): Receiving payments from UMA addresses
- [Reconciliation](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/sending-receiving-payments/reconciliation.md): Reconciliation of payments
- [Sending Payments](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/sending-receiving-payments/sending-payments.md)
- [Core Concepts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/global-p2p/terminology.md): Core concepts and terminology for the Grid API
- [](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/index.md)
- [Depositing Funds](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/depositing-funds/depositing-funds.md): Depositing funds into internal accounts
- [External Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/depositing-funds/external-accounts.md): Add and manage external bank accounts, wallets, and payment destinations for withdrawals and payouts
- [Internal Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/depositing-funds/internal-accounts.md): Learn how to manage internal accounts for holding platform and customer funds
- [Authentication](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/global-accounts/authentication.md): Register, reauthenticate, and manage Global Account credentials (passkey, OAuth, email OTP)
- [Client keys & signing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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
- [Exporting a wallet](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/global-accounts/exporting-wallet.md): Let a customer take the seed of their Global Account off Grid
- [Sessions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/global-accounts/managing-sessions.md): List and revoke active sessions on a Global Account
- [Global Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/global-accounts/overview.md): Self-custody stablecoin accounts that plug into Grid payment flows
- [Payouts & B2B](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/index.md)
- [Configuring Customers](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/onboarding/configuring-customers.md): Configuring customers for Payouts
- [Implementation Overview](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/onboarding/implementation-overview.md)
- [Platform Configuration](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/onboarding/platform-configuration.md): Configuring credentials, webhooks and currencies for your platform
- [Error Handling](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/payment-flow/error-handling.md): Handle payment failures, API errors, and transaction issues gracefully
- [List Transactions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/payment-flow/list-transactions.md): Query and filter payment history with powerful filtering and pagination options
- [Reconciliation](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/payment-flow/reconciliation.md): Match Grid transactions with your internal systems
- [Sending Payments](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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
- [Postman Collection](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/platform-tools/postman-collection.md)
- [Sandbox Testing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/platform-tools/sandbox-testing.md): Test your payouts integration in the Grid sandbox environment
- [Webhooks](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/platform-tools/webhooks.md)
- [Quickstart](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/quickstart.md): Send your first cross-border payment
- [Core Concepts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/payouts-and-b2b/terminology.md): Core concepts and terminology for the Grid API
- [Building with AI](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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
- [Capabilities](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/platform-overview/capabilities.md)
- [Configuration](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/platform-overview/configuration.md): Configure your Grid integration
- [Account Model](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/platform-overview/core-concepts/account-model.md): Internal accounts, external accounts, and how they work together
- [Currencies & Payment Rails](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/platform-overview/core-concepts/currencies-and-rails.md): Supported currencies, countries, and payment methods
- [Entities & Relationships](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/platform-overview/core-concepts/entities.md): Understanding Grid's core data model
- [Quote System](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/platform-overview/core-concepts/quote-system.md): How exchange rates, pricing, and payment execution work
- [Transaction Lifecycle](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/platform-overview/core-concepts/transaction-lifecycle.md): Follow a payment from creation to settlement
- [FAQ](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/platform-overview/introduction/faq.md)
- [What is Grid?](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/platform-overview/introduction/what-is-grid.md)
- [Use Cases](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/platform-overview/use-cases.md): Discover what you can build with Grid
- [Depositing Funds](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/accounts/depositing-funds.md): Depositing funds into internal accounts
- [External Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/accounts/external-accounts.md): Configure external bank accounts and crypto wallets for ramp destinations
- [Internal Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/accounts/internal-accounts.md): Manage internal accounts for holding fiat and crypto balances for ramp operations
- [Fiat-to-Crypto and Crypto-to-Fiat](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/conversion-flows/self-custody-wallets.md): Send and receive cryptocurrency to and from user-controlled wallets
- [Authentication](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/global-accounts/authentication.md): Register, reauthenticate, and manage Global Account credentials (passkey, OAuth, email OTP)
- [Client keys & signing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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
- [Exporting a wallet](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/global-accounts/exporting-wallet.md): Let a customer take the seed of their Global Account off Grid
- [Sessions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/global-accounts/managing-sessions.md): List and revoke active sessions on a Global Account
- [Global Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/global-accounts/overview.md): Self-custody stablecoin accounts that plug into Grid payment flows
- [Ramps](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/index.md)
- [Configuring Customers](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/onboarding/configuring-customers.md): Create and manage customers for ramp conversions
- [Implementation Overview](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/onboarding/implementation-overview.md)
- [Platform Configuration](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/onboarding/platform-configuration.md)
- [Postman Collection](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/platform-tools/postman-collection.md)
- [Sandbox Testing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/platform-tools/sandbox-testing.md): Test ramp flows safely without moving real funds
- [Webhooks](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/platform-tools/webhooks.md): Receive real-time notifications for ramp conversions, account updates, and transaction status
- [Quickstart](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/quickstart.md): Complete guide for converting fiat to crypto (on-ramp) and delivering Bitcoin to a Spark wallet
- [Core Concepts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/ramps/terminology.md): Core concepts and terminology for the Grid API
- [Paying out Bitcoin rewards](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/developer-guides/distributing-rewards.md): Send Bitcoin rewards to customers using the Grid API
- [External Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/developer-guides/external-accounts.md): Add and manage external funding sources and wallets as payment destinations for rewards
- [Implementation Overview](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/developer-guides/implementation-overview.md)
- [Internal Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/developer-guides/internal-accounts.md): Learn how to manage and fund internal accounts for holding platform and customer funds
- [Listing Transactions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/developer-guides/listing-transactions.md): Query and track Bitcoin reward payment history with filtering and pagination
- [Platform Configuration](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/developer-guides/platform-configuration.md): Configuring platform settings for rewards
- [Authentication](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/global-accounts/authentication.md): Register, reauthenticate, and manage Global Account credentials (passkey, OAuth, email OTP)
- [Client keys & signing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/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
- [Exporting a wallet](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/global-accounts/exporting-wallet.md): Let a customer take the seed of their Global Account off Grid
- [Sessions](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/global-accounts/managing-sessions.md): List and revoke active sessions on a Global Account
- [Global Accounts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/global-accounts/overview.md): Self-custody stablecoin accounts that plug into Grid payment flows
- [Rewards](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/index.md)
- [Postman Collection](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/platform-tools/postman-collection.md)
- [Sandbox Testing](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/platform-tools/sandbox-testing.md): Test your rewards integration in the Grid sandbox environment
- [Webhooks](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/platform-tools/webhooks.md)
- [Quickstart](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/quickstart.md): Complete walkthrough for buying Bitcoin and sending it as a reward to an external Spark wallet for self-custody
- [Core Concepts](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/rewards/terminology.md): Core concepts and terminology for the Grid API

## OpenAPI Specs

- [openapi.documented](https://app.stainless.com/api/spec/documented/grid/openapi.documented.yml)
- [openapi](https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/openapi.yaml)