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

Resources for payin functions.

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

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

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

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

Paths & Operations 6

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

Payins 6

Resources for payin functions.

GET
/v1/payins
List payins
list_payins 17 params → 2004004014035XX
POST
/v1/payins
Create payin
create_payin 1 param body → 2004004014035XX
GET
/v1/payins/{payin_id}
Get payin
get_payin 2 params → 2004004014034045XX
PATCH
/v1/payins/{payin_id}/metadata
Update payin metadata
update_payin_metadata 2 params body → 2004004014034045XX
POST
/v1/payins/{payin_id}/capture
Capture payin
capture_payin 2 params body → 2004004014034045XX
POST
/v1/payins/{payin_id}/void_or_refund
Void or refund payin
void_or_refund_payin 2 params body → 2004004014034044095XX

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainforest-payins-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 Devices API
Rainforest File Upload Configs API
Rainforest File Uploads API
Rainforest Forward Requests API