Skip to main content

RampAPI

Access via client.ramp.

KYB

getKybStatus

Get current KYB verification status.

startKyb

Initiate KYB verification. Returns a hosted form URL.

checkKybStatus

Force re-check KYB status with payment provider.

simulateKybApproval

Sandbox only: instantly approve KYB.

simulateKybRejection

Sandbox only: instantly reject KYB.

On-Ramp Accounts

createOnrampAccount

Create an org-level virtual bank account.

getOnrampAccount

Get the org on-ramp account.

Transactions & Summary

listTransactions

List on-ramp transactions with optional filters.

getTransaction

Get a transaction by ID.

getSummary

Aggregate volume/fee statistics.

exportTransactions

Export transactions as CSV.

Off-Ramp

createOfframpAccount

Create an org off-ramp account.

listOfframpAccounts

List org off-ramp accounts.

getOfframpStatus

Get off-ramp status.

listOfframpTransactions

List off-ramp transactions with optional filters.

getOfframpTransaction

Get an off-ramp transaction by ID.

exportOfframpTransactions

Export off-ramp transactions as CSV.

Recipients

createRecipient

Create a recipient (initiates KYB).

listRecipients

List recipients with pagination.

getRecipient

Get a recipient by ID.

archiveRecipient

Archive a recipient.

createRecipientOnrampAccount

Create an on-ramp account for a recipient.

createRecipientOfframpAccount

Create an off-ramp account for a recipient.

listRecipientOfframpAccounts

List off-ramp accounts for a recipient.

simulateRecipientOnrampTransaction

Sandbox only: simulate an on-ramp transaction for a recipient.

simulateRecipientOfframpTransaction

Sandbox only: simulate an off-ramp transaction for a recipient.

Simulation (Org-Level)

simulateOnrampTransaction

Sandbox only: simulate an on-ramp transaction.

simulateOfframpTransaction

Sandbox only: simulate an off-ramp transaction.

Types

KYB

On-Ramp Accounts

Transactions

Summary

Off-Ramp

Recipients

Simulation