> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Ramp Sandbox

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (OAuth) | ✅ |
> | Credentials auto-refresh | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | ✅ |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ Observability & data quality
>
> | Tools | Status |
> | - | - |
> | HTTP request logging | ✅ |
> | End-to-end type safety | ✅ |
> | Data runtime validation | ✅ |
> | OpenTelemetry export | ✅ |
> | Slack alerts on errors | ✅ |
> | Integration status API | ✅ |

> [accordion] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
> | Per-customer configurations | ✅ |

### Others

| Function name | Description | Type |
| - | - | - |
| `archive-purchase-order` | Archive (soft-remove) a purchase order. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-bill-draft` | Create a bill in draft state, to be reviewed/edited before submission. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-bill` | Create a bill directly (not via the draft flow) with line items. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-department` | Create a new department. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-fund` | Create a new fund (spend limit) for a user, optionally auto-issuing a card against it. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-location` | Create a new location. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-mileage-reimbursement` | Create a mileage reimbursement for a user business trip. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-physical-card` | Issue a new physical card to a user, optionally attached to a specific fund/spend limit. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-purchase-order` | Create a new purchase order against a vendor. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-user-invite` | Create a new user and trigger an async task to send them an email invite. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-vendor` | Create a new vendor with a primary contact. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `deactivate-user` | Deactivate a user, revoking login, card-spend, and notification access. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-vendor` | Permanently delete a vendor. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `find-or-create-vendor` | Find a vendor by exact name or create it when missing, flagging ambiguous duplicate names. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-bank-account` | Retrieve a single externally-linked bank account by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-banking-account-balance-history` | Get the daily available balance history for a Ramp Treasury/Business banking account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-banking-account-balance-trend` | Get a Ramp Treasury/Business banking account merged with its daily balance history and a computed balance trend. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-bill-remittance-receipt` | Fetch the PDF remittance receipt for a paid bill. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-bill` | Retrieve a single bill by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-business-balance` | Get the business aggregate card balance, limits, and billing cycle dates. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-business-profile` | Get the connected business's own profile (legal name, address, phone, card limits). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-card-full-status` | Composite: a card (physical or virtual) merged with its fund's current spending limit/balance and its recent transactions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-cashback` | Retrieve a single cashback record by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-department` | Retrieve a single department by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-entity` | Retrieve a single business entity by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-fund` | Retrieve a single fund by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-item-receipt` | Retrieve a single item receipt by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-location` | Retrieve a single location by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-physical-card` | Retrieve a single physical card by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-purchase-order` | Retrieve a single purchase order by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-receipt` | Retrieve a single receipt by ID, including its metadata and pre-signed download URL. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-reimbursement` | Retrieve a single reimbursement by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-spend-program` | Retrieve a single spend program by ID, including its full custom-form field definitions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-statement` | Retrieve a single statement by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-transaction-full-context` | Composite: a transaction merged with its receipts and current memo in one call. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-transaction-memo` | Get the current memo text on a transaction. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-transaction` | Retrieve a single transaction by its ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-transfer` | Retrieve a single transfer by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-trip` | Retrieve a single trip by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-user-creation-task-status` | Poll the async task created by create-user-invite to retrieve the new user ID once ready. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-user` | Retrieve a single Ramp user by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-vendor` | Retrieve a single vendor by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-virtual-card` | Retrieve a single virtual card by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `hold-bill` | Place a hold on a bill, pausing any pending payment. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `hold-or-release-bill-with-validation` | Place or remove a hold on a bill after validating that the status transition is allowed. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-approvals` | List the approval chain and history for a set of bills, reimbursements, or transactions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-audit-log-events` | List business-wide audit log events (logins, approvals, transaction state changes, settings changes, etc). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-bank-accounts` | List external bank accounts linked to the business. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-banking-accounts` | List Ramp's own Business Account / Treasury accounts (wallet, brokerage, investment). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-bill-drafts` | List bills that are still in draft state (not yet submitted into the approval/payment flow). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-bills` | List Bill Pay bills with extensive filtering. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-cashbacks` | List cashback payouts earned on card spend. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-departments` | List departments. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-entities` | List legal entities/subsidiaries under the business. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-funds` | List funds - Ramp's current API name for what the product UI still calls "spend limits" - each a card-attached spending limit with its own balance and restrictions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-item-receipts` | List item receipts recording physical or quantity receipt against purchase order line items. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-locations` | List office/work locations. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-merchants` | List merchants the business has transacted with, with category and auto-approval metadata. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-physical-cards` | List physical cards issued to employees. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-purchase-orders` | List procurement purchase orders. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-receipts` | List receipt images/PDFs, optionally filtered by transaction or reimbursement. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-reimbursements` | List out-of-pocket and mileage reimbursements. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-repayments` | List off-Ramp card repayments (e.g. a cardholder reimbursing the business for a disallowed personal charge). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-roles` | List the custom/base roles defined on the business, with their permission capabilities. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-spend-programs` | List spend program templates that funds can be created from or inherit restrictions from. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-statements` | List card statements. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-transactions` | List card transactions, with extensive filtering and cursor pagination. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-transfers` | List transfers between the business's bank accounts and its Ramp balance. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-trips` | List business trips, including their location segments, linked spend events, and total spend. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-users` | List employees/users on the business. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-vendor-accounts` | List a vendor's bank accounts on file, used as payment destinations for bills. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-vendor-contacts` | List contacts associated with a vendor. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-vendor-credits` | List credits issued by vendors (e.g. refunds/overpayments) applicable against future bills. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-vendors` | List vendors (payees for bills and purchase orders). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-virtual-cards` | List virtual cards. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `manage-user-invite` | Schedule, reschedule, deschedule, or immediately send a user's pending invite. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `reactivate-user` | Reactivate a previously-deactivated user. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `release-bill` | Remove a hold previously placed on a bill. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `resume-physical-card` | Reverse a suspension on a physical card. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `set-transaction-memo` | Set or replace the memo text on a transaction. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `submit-bill-draft` | Submit a previously-created draft bill into the normal approval/payment pipeline. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `suspend-physical-card` | Temporarily suspend a physical card, blocking new transactions until it is unsuspended. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `terminate-fund` | Permanently terminate a fund (spend limit), including any cards issued against it. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `terminate-physical-card` | Permanently terminate a physical card. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-department` | Rename a department. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-fund` | Update a fund. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-location` | Rename a location or reassign it to a different entity. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-physical-card` | Update the display name, fund assignment, or automatic-routing setting of a physical card. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-transaction-line-items` | Set or replace the accounting line-item split (amount, memo, and accounting field selections) on a transaction. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-user` | Update a user's name, department, location, manager, or role. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-vendor` | Update a vendor (name, address, payment terms, or active status) in Ramp. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `users` | Sync employees/users, including suspended users. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `bank-accounts` | Sync externally-linked bank accounts used as Bill Pay funding sources and vendor payment destinations. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `banking-account-balances` | Sync the daily available balance history for every Ramp Treasury/Business account. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `bills` | Syncs Bill Pay bills from Ramp, including their status, approval, payment and line item details. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `cards` | Sync both physical and virtual cards into one unified card roster sync. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `departments` | Sync departments from Ramp. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `locations` | Sync office/work locations. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `reimbursements` | Syncs out-of-pocket and mileage reimbursements and user repayments, incrementally by last-updated time. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `statements` | Sync card statements, including statement periods, balances, and line items. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `transactions` | Sync Ramp card transactions (including declined ones), incrementally by user\_transaction\_time with a periodic full refresh. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `vendors` | Sync vendors incrementally by updated\_at, with a daily full refresh that detects deleted vendors. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |

## Setup guide

*No setup guide yet.*

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

> [!NOTE]
>
> Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/ramp-sandbox.mdx)

## Useful links

* [Ramp REST API docs](https://docs.ramp.com/developer-api/v1)
* [Full list of OAuth scopes](https://docs.ramp.com/developer-api/v1/authorization/scopes)

> [!NOTE]
>
> Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/ramp-sandbox.mdx)

## API gotchas

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/ramp-sandbox.mdx)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.