Ramp - Nango Docs

Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

Pre-built tooling

✅ Authorization

Tools	Status
Pre-built authorization (OAuth)	✅
Credentials auto-refresh	✅
Pre-built authorization UI	✅
Custom authorization UI	✅
Expired credentials detection	✅

✅ 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	✅

✅ 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	✅

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

Access requirements

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

Setup guide

No setup guide yet.

Need help getting started? Get help in the community.

Contribute improvements to the setup guide by editing this page

Useful links

Contribute useful links by editing this page

API gotchas

In order to authenticate you need to have a user permission of BUSINESS_OWNER or BUSINESS_ADMIN

Contribute API gotchas by editing this page

​Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

​Pre-built tooling

​Others

​Access requirements

​Setup guide

​Useful links

​API gotchas

Overview

Pre-built tooling

Others

Access requirements

Setup guide

Useful links

API gotchas