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

JustiFi Checkouts API

Checkouts can be used to collect payments directly via API, or using our Checkout component.You can use a checkout to complete a payment via JustiFi, via BNPL, via terminal,and to purchase insurance in a single transaction.All attempts to complete a payment will be recorded, along with the outcome of a payment.

JustiFi Checkouts API is one of 27 APIs that JustiFi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https://api.justifi.ai/v1.

6 operations 4 paths 15 schemas 2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://api.justifi.ai/v1
Terms of Service
Resource Areas
1

Paths & Operations 6

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

Checkouts 6

Checkouts can be used to collect payments directly via API, or using our Checkout component. You can use a checkout to complete a payment via JustiFi, via BNPL, via terminal, and…

POST
/checkouts
Create a Checkout
CreateCheckout 2 params body → 201
GET
/checkouts
List Checkouts
ListCheckouts 5 params → 200
GET
/checkouts/{id}
Get Checkout
GetCheckout 2 params → 200
PATCH
/checkouts/{id}
Update a Checkout
UpdateCheckout 2 params body → 200
POST
/checkouts/{id}/complete
Complete a Checkout
CompleteCheckout 2 params body → 201
POST
/checkouts/{id}/refunds
Refund a Checkout
RefundCheckout 2 params body → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are CardPayment (33 properties), Checkout (20 properties), CheckoutCompletion (16 properties), CheckoutCompletionAttempt (15 properties). Each schema is shown below with its type and property counts.

CheckoutCompletionAttempt
object
15 properties
CheckoutRefund
object
8 properties
CardPaymentMethod
object
4 properties
CardPayment
object
33 properties
Checkout
object
20 properties
CardPaymentWithEnvelope
object
4 properties
TransactionHold
object
2 properties
CheckoutCompletion
object
16 properties
FeeResponse
object
A fee object in API responses. The fees array is empty in the Create Payment response — subscribe to payment webhook events (recommended) to receive the full f…
8 properties 2 required
Envelope
object
4 properties
Envelope-list
object
4 properties
Fee
object
A fee object specifying type and amount
2 properties 2 required
Card
object
13 properties
ApplicationFee
object
5 properties
PageInfo
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

justifi-checkouts-api-openapi.yml Raw ↑

Other APIs JustiFi publishes across the network.

JustiFi Ach Return Fees API
JustiFi Address API
JustiFi API Credentials API
JustiFi Balance Transactions API
JustiFi Bank Account API
JustiFi Bind Insurance API
JustiFi Business API
JustiFi Disputes API
JustiFi Document API
JustiFi Fee Configurations API
JustiFi Identity API
JustiFi Payment Method Groups API