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

The merchants API from R2 — 1 operation(s) for merchants.

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

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

This API exposes 1 operation across 1 path, and defines 11 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/.

1 operations 1 paths 11 schemas 1 PATCH

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 merchants API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (JWT).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

merchants 1
PATCH
/webhooks/merchants/{external_id}
Process a merchant.
2 params body → 200400404500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are domain.MerchantMetadataBusiness (15 properties), domain.MerchantMetadataAddress (12 properties), domain.LegalRepresentative (11 properties), domain.MerchantMetadataBank (11 properties). Each schema is shown below with its type and property counts.

domain.MerchantMetadataBank
object
11 properties
domain.MerchantMetadataAdditionalInformation
object
domain.MerchantMetadataBankDisbursementInfo
object
5 properties
domain.Docs
object
2 properties
domain.MerchantMetadataBusiness
object
15 properties
domain.MerchantMetadataAddress
object
12 properties
domain.MerchantMetadata
object
6 properties
domain.MerchantMetadataBusinessDoc
object
2 properties
domain.MerchantMetadataContact
object
2 properties
domain.LegalRepresentative
object
11 properties
domain.Merchant
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

r2-merchants-api-openapi.yml Raw ↑

Other APIs R2 publishes across the network.

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