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

Increase Card Payments API

Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.

Increase Card Payments API is one of 56 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

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

2 operations 2 paths 14 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.increase.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Increase Card 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 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Card Payments 2

Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.

GET
/card_payments
List Card Payments
list_card_payments 8 params → 2004XX5XX
GET
/card_payments/{card_payment_id}
Retrieve a Card Payment
retrieve_a_card_payment 1 param → 2004XX5XX

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are card_authentication (39 properties), card_authorization (29 properties), card_financial (28 properties), card_settlement (24 properties). Each schema is shown below with its type and property counts.

card_authorization
object
Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction.
29 properties 29 required
card_increment
object
Card Increments increase the pending amount of an authorized transaction.
16 properties 16 required
error
card_fuel_confirmation
object
Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed.
9 properties 9 required
card_refund
object
Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card wit…
20 properties 20 required
card_balance_inquiry
object
Card Balance Inquiries are transactions that allow merchants to check the available balance on a card without placing a hold on funds, commonly used when a cus…
22 properties 22 required
card_settlement
object
Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly…
24 properties 24 required
card_authorization_expiration
object
Card Authorization Expirations are cancellations of authorizations that were never settled by the acquirer.
6 properties 6 required
inbound_card_validation
object
Inbound Card Validations are requests from a merchant to verify that a card number and optionally its address and/or Card Verification Value are valid.
22 properties 22 required
card_financial
object
Card Financials are temporary holds placed on a customer's funds with the intent to later clear a transaction.
28 properties 28 required
card_payment_list
object
A list of Card Payment objects.
2 properties 2 required
card_authentication
object
Card Authentications are attempts to authenticate a transaction or a card with 3DS.
39 properties 39 required
card_payment
object
Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.
9 properties 9 required
card_reversal
object
Card Reversals cancel parts of or the entirety of an existing Card Authorization.
22 properties 22 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

increase-card-payments-api-openapi.yml Raw ↑

Other APIs Increase publishes across the network.

Increase Account Numbers API
Increase Account Statements API
Increase Account Transfers API
Increase Accounts API
Increase Ach Prenotifications API
Increase Ach Transfers API
Increase Card Disputes API
Increase Card Purchase Supplements API
Increase Card Push Transfers API
Increase Card Tokens API
Increase Card Validations API
Increase Cards API