Before you begin
Make sure you have:- US bank account: this is where the user’s or company’s funds originate from.
- Rain collateral contracts: automatically deployed when a user’s or company’s compliance status is
Approvedunder a Rain-Managed program. - API keys: you need access to the
contractsendpoints to enable this feature.
Compliance data requirements
Enabling onramp requires the user or company to have completed verification: Rain sends their verified identity data (name and date of birth for consumers, company name for companies) to the banking provider when it provisions the virtual account. A contract whose customer hasn’t been through verification, or that isn’t associated with a customer, can’t enable onramp — the API returns a400 such as Contract has no associated team, and a chain the
provider doesn’t support returns 400 Unsupported chain ID.
Enable onramping
Enabling Rain’s onramp feature means generating unique ACH, RTP, and wire transfer details on your user’s smart contract.API flow
When a user wants to onramp fiat into their smart contract, you need to enable the onramp feature on their contract and provide them with dedicated banking credentials. Any funds sent to these credentials are automatically converted to stablecoin and deposited into their smart contract.Action / step
Steps to enable onramping
You need to call these API endpoints synchronously to get the virtual account details for a user or company.1
Get the user's smart contract
Call Get smart contract information for a user with the
userId or companyId of the entity requesting to transfer. This returns the entity’s available contracts from their respective chains. Use the contractId for the contract the entity intends to fund.2
Enable the onramp feature
Call Update a smart contract to enable the Onramp feature. Once the operation completes, this returns an
Accepted response body.3
Retrieve the generated virtual account
Call Get smart contract information for a user again with the same
userId or companyId. The contract object now contains the generated onramp account details the entity uses to fund the contract.Sample response
What happens when funds are received
Once you provide the virtual account details to your user, they can initiate a transfer from their US bank account using any of the three available rails:- ACH: funds typically appear within 1-3 business days.
- RTP: funds typically appear within minutes.
- Wire: funds typically appear within minutes.
What’s next
Onramps
If you don’t need funds delivered into a specific collateral contract, use
the general payment-routes onramp flow instead.
Withdraw collateral
Move stablecoin back out of a Rain collateral contract.
Review Rain-Managed programs
Understand the requirements and constraints of a Rain-Managed program.
Review payments compliance
See how Rain verifies account owners and screens transactions.