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

R2 payments API

The payments API from R2 — 2 operation(s) for payments.

R2 payments API is one of 8 APIs that R2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 0.1.

Requests are made against 2 base URLs: https://gateway-dev.r2capital.co:443/v2, https://gateway-dev.r2capital.co/v2/.

2 operations 2 paths 4 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1
Base URL
https://gateway-dev.r2capital.co/v2/
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

R2 payments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (JWT).

Paths & Operations 2

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

payments 2
POST
/api/payments/payin/refund/{id}
Refund partially one collection.
1 param body → 201400404500
POST
/api/payments/payin/revert/{id}
Revert one collection.
1 param → 201400404500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are paymentsdomain.RevertCollectionResponse (7 properties), paymentsdomain.RefundRequest (5 properties), paymentsdomain.RevertData (3 properties), paymentsdomain.RefundPaymentResponse (2 properties). Each schema is shown below with its type and property counts.

paymentsdomain.RefundPaymentResponse
object
2 properties
paymentsdomain.RevertData
object
3 properties
paymentsdomain.RefundRequest
object
5 properties
paymentsdomain.RevertCollectionResponse
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

r2-payments-api-openapi.yml Raw ↑

Other APIs R2 publishes across the network.

R2 callbacks API
R2 collections API
R2 events API
R2 financings API
R2 merchants API
R2 Sandbox API
R2 transactions API