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

BILL Payments API

The Payments API from BILL — 5 operation(s) for payments.

BILL Payments API is one of 11 APIs that BILL 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.

This API exposes 6 operations across 5 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against 4 base URLs: https://gateway.prod.bill.com/connect/v3, https://gateway.stage.bill.com/connect/v3, https://api.bill.com/v3, https://api-sandbox.bill.com/v3.

6 operations 5 paths 1 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://gateway.prod.bill.com/connect/v3
Authentication
API Key
License
Proprietary
Resource Areas
1

Authentication & Security 1

BILL Payments API declares 1 security scheme for authenticating requests. An API key is passed in the header as sessionId (sessionAuth). By default, every request must be authenticated.

  • sessionAuth — Session identifier obtained from POST /login. Expires after 35 minutes of inactivity. A devKey (developer key) is also required on requests and is sent alongsi…

Paths & Operations 6

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

Payments 6
GET
/payments
List payments
listPayments 2 params → 200
POST
/payments
Create a payment (MFA required)
createPayment body → 201
POST
/payments/bulk
Create a bulk payment (MFA required)
createPaymentsBulk body → 200
GET
/payments/{paymentId}
Get payment details
getPayment 1 param → 200
POST
/payments/{paymentId}/cancel
Cancel a scheduled payment
cancelPayment 1 param → 200
POST
/payments/{paymentId}/void
Void a processed payment
voidPayment 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is PaymentCreate (6 properties). Each schema is shown below with its type and property counts.

PaymentCreate
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bill-payments-api-openapi.yml Raw ↑

Other APIs BILL publishes across the network.

BILL v3 API
BILL Elements
BILL Authentication API
BILL Bills API
BILL Customers API
BILL Funding Accounts API
BILL Invoices API
BILL Organizations API
BILL Vendors API
BILL Webhooks API