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

Rillet Customer Payments API

The Customer Payments API from Rillet — 1 operation(s) for customer payments.

Rillet Customer Payments API is one of 28 APIs that Rillet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version v4.0.

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

2 operations 1 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v4.0
Base URL
https://api.rillet.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 2

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

Customer Payments 2
POST
/customers/{customer_id}/settings/payment
Sets up auto-payment
setup-auto-payment 1 param body → 200default
GET
/customers/{customer_id}/settings/payment
Gets payment method
get-payment-method 1 param → 200default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Error (4 properties), CustomerPaymentMethod (3 properties), SetupUpAutoPaymentRequest (1 property), PaymentSetupResponse (1 property). Each schema is shown below with its type and property counts.

PaymentSetupResponse
object
1 property 1 required
CustomerPaymentMethod
object
3 properties 2 required
SetupUpAutoPaymentRequest
object
1 property
Error
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-customer-payments-api-openapi.yml Raw ↑

Other APIs Rillet publishes across the network.

Rillet API Key API
Rillet Bank accounts API
Rillet Bank Transactions API
Rillet Bill Payments API
Rillet Bills API
Rillet Books periods API
Rillet Charges API
Rillet Chart of Accounts API
Rillet Contract Items API
Rillet Contracts API
Rillet Credit Memos API
Rillet Customers API