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 Devices API

Resources for device functions.

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

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

This API exposes 8 operations across 6 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.

8 operations 6 paths 0 schemas 1 DELETE2 GET5 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 Devices API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (APIKey) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 8

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

Devices 8

Resources for device functions.

POST
/v1/device_registrations
Create device registration
create_device_registration 1 param body → 2004004014035XX
GET
/v1/device_registrations
List device registrations
list_device_registrations 8 params → 2004004014035XX
GET
/v1/device_registrations/{device_registration_id}
Get device registration
get_device_registration 2 params → 2004004014034045XX
DELETE
/v1/device_registrations/{device_registration_id}
Delete device registration
delete_device_registration 2 params → 2044004014034045XX
POST
/v1/device_registrations/{device_registration_id}/payin
Present payin on a registered device
create_device_payin 2 params body → 2004004014034044095XX
POST
/v1/device_registrations/{device_registration_id}/payment_method
Present payment method on a registered device
create_device_payment_method 2 params body → 2004004014034044095XX
POST
/v1/device_registrations/{device_registration_id}/cancel
Cancel presented entity on device
cancel_device_presented 2 params → 2022044004014034045XX
POST
/v1/device_registrations/{device_registration_id}/simulate
Simulate device interaction
simulate_on_device 2 params body → 2044004014034044095XX

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainforest-devices-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 Deposits API
Rainforest File Upload Configs API
Rainforest File Uploads API
Rainforest Forward Requests API
Rainforest Health API