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

Increase Real Time Payments Transfers API

The Real Time Payments Transfers API from Increase — 4 operation(s) for real time payments transfers.

Increase Real Time Payments Transfers API is one of 56 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Real Time Payments Transfers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

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

5 operations 4 paths 4 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.increase.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Increase Real Time Payments Transfers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

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

Real Time Payments Transfers 5
GET
/real_time_payments_transfers
List Real-Time Payments Transfers
list_real_time_payments_transfers 10 params → 2004XX5XX
POST
/real_time_payments_transfers
Create a Real-Time Payments Transfer
create_a_real_time_payments_transfer body → 2004XX5XX
GET
/real_time_payments_transfers/{real_time_payments_transfer_id}
Retrieve a Real-Time Payments Transfer
retrieve_a_real_time_payments_transfer 1 param → 2004XX5XX
POST
/real_time_payments_transfers/{real_time_payments_transfer_id}/approve
Approve a Real-Time Payments Transfer
approve_a_real_time_payments_transfer 1 param → 2004XX5XX
POST
/real_time_payments_transfers/{real_time_payments_transfer_id}/cancel
Cancel a pending Real-Time Payments Transfer
cancel_a_pending_real_time_payments_transfer 1 param → 2004XX5XX

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are real_time_payments_transfer (25 properties), create_a_real_time_payments_transfer_parameters (11 properties), real_time_payments_transfer_list (2 properties). Each schema is shown below with its type and property counts.

create_a_real_time_payments_transfer_parameters
object
11 properties 4 required
error
real_time_payments_transfer_list
object
A list of Real-Time Payments Transfer objects.
2 properties 2 required
real_time_payments_transfer
object
Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.
25 properties 25 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

increase-real-time-payments-transfers-api-openapi.yml Raw ↑

Other APIs Increase publishes across the network.

Increase Account Numbers API
Increase Account Statements API
Increase Account Transfers API
Increase Accounts API
Increase Ach Prenotifications API
Increase Ach Transfers API
Increase Card Disputes API
Increase Card Payments API
Increase Card Purchase Supplements API
Increase Card Push Transfers API
Increase Card Tokens API
Increase Card Validations API