How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
BILT

BILT Headless payments API

Charge a customer's current default Bilt payment method with no BiltUI, for subscriptions, autopay, or other off-session payments. Theoutcome arrives as a `payment.*` webhook.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 2 operations across 2 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 0.2.0-draft.

Requests are made against 2 base URLs: https://partnerapi.biltrewards.com, https://staging.partnerapi.biltrewards.com.

2 operations 2 paths 21 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.2.0-draft
Servers
https://partnerapi.biltrewards.com
https://staging.partnerapi.biltrewards.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

BILT Headless payments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (checkoutPartnerOAuth) using the clientCredentials flow. By default, every request must be authenticated.

  • checkoutPartnerOAuth — OAuth 2.0 client credentials against the enterprise-partner Keycloak realm. Bilt issues your client id and client secret during onboarding; tokens carry an aud…

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.

Headless payments 2

Charge a customer's current default Bilt payment method with no Bilt UI, for subscriptions, autopay, or other off-session payments. The outcome arrives as a payment. webhook.

POST
/partner/checkout/v1/headless-payments
Create a headless payment
createHeadlessPayment 1 param body → 202400401404409429500503
POST
/partner/checkout/v1/headless-payments/sync
Create a headless payment and wait for the outcome
createHeadlessPaymentSync 1 param body → 200202400401404409429500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ExternalLineItem (6 properties), HeadlessPaymentSucceeded (6 properties), HeadlessPaymentFailed (5 properties), HeadlessPayment (5 properties). Each schema is shown below with its type and property counts.

HeadlessPaymentSucceeded
object
6 properties 6 required
PaymentWebhookEvent
Standard Webhooks payload. type is the discriminator: each event type fixes data.mode and data.status and states exactly which fields are present, so a validat…
CheckoutSessionCompletedEvent
HeadlessPayment
object
Acknowledgement that a headless payment was accepted for processing. The settled outcome arrives by webhook.
5 properties 5 required
WebhookEventBase
object
2 properties 3 required
WebhookDataBase
object
4 properties 5 required
HeadlessPaymentOutcomeEnvelope
object
1 property 1 required
IntegratorMetadata
objectnull
Optional integrator-owned correlation values (up to 20 keys, string values up to 500 characters). Echoed back on webhooks and never interpreted by Bilt. Do not…
ExternalLineItem
object
6 properties 6 required
PaymentFailure
object
Why a headless charge could not be completed.
3 properties 3 required
PaymentAmounts
object
Split of the order total between eligible Bilt credits and the customer's card. subtotalCents = creditsAppliedCents + chargedAmountCents. On a 202 acceptance c…
4 properties 4 required
PaymentSucceededEvent
CheckoutSessionCancelledEvent
ErrorResponse
object
Error envelope returned on every non-2xx response. Branch on the stable code, not the human-readable message.
1 property 1 required
HeadlessPaymentFailed
object
5 properties 5 required
CheckoutSessionExpiredEvent
PaymentFailedEvent
ErrorDetail
object
4 properties 4 required
HeadlessPaymentEnvelope
object
1 property 1 required
HeadlessPaymentOutcome
CreatePaymentRequest
object
Shared request body for one-time payment sessions and headless payments. Unknown properties are rejected with 400 INVALIDREQUEST.
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bilt-headless-payments-api-openapi.yml Raw ↑

Other APIs BILT publishes across the network.

Bilt Checkout SDK
AE Profile APIs.io
BILT Default payment method API
AE Profile APIs.io
BILT One-time payments API
AE Profile APIs.io
#Headless payments
← Back to B APIs
API Details
ID
bilt:bilt-headless-payments-api
Server
https://partnerapi.biltrewards.com
Docs
https://developers.bilt.com/docs/
Provider
BILT
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bilt-headless-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bilt-headless-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of BILT Headless payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.