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

Capchase Pay API

The Pay API from Capchase — 8 operation(s) for pay.

Capchase Pay API is published by Capchase on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pay. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 9 operations across 8 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against a single base URL, https://universe.capchase.com/api/v2.

9 operations 8 paths 16 schemas 1 DELETE4 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://universe.capchase.com/api/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Capchase Pay API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Basic auth: username=clientId, password=clientSecret. Request credentials at pay@capchase.com.

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Pay 9
POST
/pay/buyers
Create buyer
PayExternalController_createBuyer body → 201
POST
/pay/subscriptions
Create subscription
PayExternalController_createSubscription body → 201
GET
/pay/subscriptions
List subscriptions
PayExternalController_listSubscriptions 3 params → 200
DELETE
/pay/subscriptions/{key}
Archive subscription
PayExternalController_delete 1 param → 204
GET
/pay/buyers/{id}
Get buyer
PayExternalController_getBuyer 1 param → 200
GET
/pay/subscriptions/{key}/instalment/{instalmentKey}/receipt
Get instalment receipt
PayExternalController_getInstalmentReceipt 2 params → 200
GET
/pay/subscriptions/{id}
Get subscription
PayExternalController_getSubscription 1 param → 200
PATCH
/pay/buyers/{id}/update-external-id
Update buyer external Id
PayExternalController_updateBuyerExternalId 1 param body → 200
POST
/pay/buyers/{id}/renew-qualification
Renew buyer qualification
PayExternalController_updateBuyerQualification 1 param → 201

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are SubscriptionApiVo (23 properties), BuyerResponseDto (20 properties), CreateBuyerApiDto (13 properties), CreateNewSubscriptionParametricDto (8 properties). Each schema is shown below with its type and property counts.

SubscriptionInstallmentVo
object
2 properties 2 required
InstalmentReceiptResponseVo
object
1 property 1 required
BuyerTerms
object
7 properties 5 required
CreateBuyerApiDto
object
13 properties 7 required
SubscriptionApiVo
object
23 properties 12 required
CreateNewSubscriptionParametricItemDto
object
8 properties 6 required
BuyerResponseDto
object
20 properties 19 required
FeeBipsVo
object
3 properties 3 required
AmountBreakdownVo
object
1 property 1 required
FeeBreakdownVo
object
1 property 1 required
SubscriptionItemVo
object
4 properties 3 required
OverallBreakdownVo
object
1 property 1 required
SubscriptionBreakdownVo
object
4 properties 4 required
UpdateBuyerExternalIdRequestDto
object
1 property 1 required
MoneyVo
object
3 properties 3 required
CreateNewSubscriptionParametricDto
object
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capchase-pay-api-openapi.yml Raw ↑