Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rainforest Deposits API

Resources for deposit functions.

Rainforest Deposits API is one of 23 APIs that Rainforest publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deposits. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 5 operations across 5 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.sandbox.rainforestpay.com, https://api.rainforestpay.com.

5 operations 5 paths 0 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.rainforestpay.com
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Rainforest Deposits API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (APIKey) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Deposits 5

Resources for deposit functions.

GET
/v1/deposits
List deposits
list_deposits 13 params → 2004004014035XX
GET
/v1/deposits/{deposit_id}
Get deposit
get_deposit 2 params → 2004004014034045XX
GET
/v1/deposits/{deposit_id}/activity
Get deposit activity
get_deposit_activity 10 params → 2004004014034045XX
POST
/v1/deposits/{deposit_id}/simulate
Simulate deposit status change
simulate_deposit_status 2 params body → 2004004014034045XX
POST
/v1/merchants/{merchant_id}/simulate_deposit
Simulate merchant deposit creation
simulate_merchant_deposit 2 params → 2044004014034045XX

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainforest-deposits-api-openapi.yml Raw ↑

Other APIs Rainforest publishes across the network.

Rainforest ACH Returns API
Rainforest API Keys API
Rainforest Billing Profiles API
Rainforest BIN Lookups API
Rainforest Chargebacks API
Rainforest Deposit Method Configs API
Rainforest Deposit Methods API
Rainforest Devices API
Rainforest File Upload Configs API
Rainforest File Uploads API
Rainforest Forward Requests API
Rainforest Health API