Increase Real Time Decisions API
The Real Time Decisions API from Increase — 2 operation(s) for real time decisions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/increase-real-time-decisions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build!
title: Increase Real Time Decisions API
version: 0.0.1
servers:
- url: https://api.increase.com
- url: https://sandbox.increase.com
security:
- bearerAuth: []
tags:
- name: Real Time Decisions
paths:
/real_time_decisions/{real_time_decision_id}:
get:
operationId: retrieve_a_real_time_decision
parameters:
- example: real_time_decision_j76n2e810ezcg3zh5qtn
in: path
name: real_time_decision_id
required: true
schema:
description: The identifier of the Real-Time Decision.
type: string
x-documentation-priority: default
x-id-reference-to: Real-Time Decisions
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/real_time_decision'
description: Real-Time Decision
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Retrieve a Real-Time Decision
x-sandbox-only: false
x-tag: Real-Time Decisions
tags:
- Real Time Decisions
/real_time_decisions/{real_time_decision_id}/action:
post:
operationId: action_a_real_time_decision
parameters:
- example: real_time_decision_j76n2e810ezcg3zh5qtn
in: path
name: real_time_decision_id
required: true
schema:
description: The identifier of the Real-Time Decision.
type: string
x-documentation-priority: default
x-id-reference-to: Real-Time Decisions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/action_a_real_time_decision_parameters'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/real_time_decision'
description: Real-Time Decision
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Action a Real-Time Decision
x-sandbox-only: false
x-tag: Real-Time Decisions
tags:
- Real Time Decisions
components:
schemas:
error:
anyOf:
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 404
type: integer
title:
type: string
type:
enum:
- api_method_not_found_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 403
type: integer
title:
type: string
type:
enum:
- environment_mismatch_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
resource_id:
description: ''
type: string
x-documentation-priority: default
status:
enum:
- 409
type: integer
title:
type: string
type:
enum:
- idempotency_key_already_used_error
type: string
required:
- type
- title
- detail
- status
- resource_id
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 403
type: integer
title:
type: string
type:
enum:
- insufficient_permissions_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 500
type: integer
title:
type: string
type:
enum:
- internal_server_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
reason:
description: ''
enum:
- deleted_credential
- expired_credential
- ip_not_allowed
- no_credential
- no_header
- no_api_access
- wrong_environment
type: string
x-documentation-priority: default
x-enum-descriptions:
- deleted_credential
- expired_credential
- ip_not_allowed
- no_credential
- no_header
- no_api_access
- wrong_environment
status:
enum:
- 401
type: integer
title:
type: string
type:
enum:
- invalid_api_key_error
type: string
required:
- type
- title
- detail
- status
- reason
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 409
type: integer
title:
type: string
type:
enum:
- invalid_operation_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
errors:
description: All errors related to parsing the request parameters.
items:
additionalProperties: true
properties: {}
title: ErrorsElement
type: object
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: ErrorsElements
type: array
x-documentation-priority: default
status:
enum:
- 400
type: integer
title:
type: string
type:
enum:
- invalid_parameters_error
type: string
required:
- type
- title
- detail
- status
- errors
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 400
type: integer
title:
type: string
type:
enum:
- malformed_request_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 404
type: integer
title:
type: string
type:
enum:
- object_not_found_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 403
type: integer
title:
type: string
type:
enum:
- private_feature_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
retry_after:
anyOf:
- description: ''
type: integer
x-documentation-priority: default
- type: 'null'
status:
enum:
- 429
type: integer
title:
type: string
type:
enum:
- rate_limited_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
action_a_real_time_decision_parameters:
additionalProperties: false
example:
card_authorization:
approval:
cardholder_address_verification_result:
line1: match
postal_code: no_match
decision: approve
properties:
card_authentication:
additionalProperties: false
description: If the Real-Time Decision relates to a 3DS card authentication attempt, this object contains your response to the authentication.
properties:
decision:
description: Whether the card authentication attempt should be approved or declined.
enum:
- approve
- challenge
- deny
type: string
x-documentation-priority: default
x-enum-descriptions:
- Approve the authentication attempt without triggering a challenge.
- Request further validation before approving the authentication attempt.
- Deny the authentication attempt.
required:
- decision
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
card_authentication_challenge:
additionalProperties: false
description: If the Real-Time Decision relates to 3DS card authentication challenge delivery, this object contains your response.
properties:
result:
description: Whether the card authentication challenge was successfully delivered to the cardholder.
enum:
- success
- failure
type: string
x-documentation-priority: default
x-enum-descriptions:
- Your application successfully delivered the one-time code to the cardholder.
- Your application was unable to deliver the one-time code to the cardholder.
success:
additionalProperties: false
description: If your application was able to deliver the one-time code, this contains metadata about the delivery.
properties:
email:
description: The email address that was used to deliver the one-time code to the cardholder.
format: email
maxLength: 200
minLength: 1
type: string
x-documentation-priority: default
phone:
description: The phone number that was used to deliver the one-time code to the cardholder via SMS.
maxLength: 200
minLength: 1
type: string
x-documentation-priority: default
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
required:
- result
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
card_authorization:
additionalProperties: true
description: If the Real-Time Decision relates to a card authorization attempt, this object contains your response to the authorization.
properties:
approval:
additionalProperties: false
description: If your application approves the authorization, this contains metadata about your decision to approve. Your response here is advisory to the acquiring bank. The bank may choose to reverse the authorization if you approve the transaction but indicate the address does not match.
properties:
cardholder_address_verification_result:
additionalProperties: false
description: Your decisions on whether or not each provided address component is a match. Your response here is evaluated against the customer's provided `postal_code` and `line1`, and an appropriate network response is generated. For more information, see our [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides) guide.
properties:
line1:
description: Your decision on the address line of the provided address.
enum:
- match
- no_match
type: string
x-documentation-priority: default
x-enum-descriptions:
- The cardholder address verification result matches the address provided by the merchant.
- The cardholder address verification result does not match the address provided by the merchant.
postal_code:
description: Your decision on the postal code of the provided address.
enum:
- match
- no_match
type: string
x-documentation-priority: default
x-enum-descriptions:
- The cardholder address verification result matches the address provided by the merchant.
- The cardholder address verification result does not match the address provided by the merchant.
required:
- line1
- postal_code
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
partial_amount:
description: 'If the transaction supports partial approvals (`partial_approval_capability: supported`) the `partial_amount` can be provided in the transaction''s settlement currency to approve a lower amount than was requested.'
minimum: 1
type: integer
x-documentation-priority: default
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
decision:
description: Whether the card authorization should be approved or declined.
enum:
- approve
- decline
type: string
x-documentation-priority: default
x-enum-descriptions:
- Approve the authorization.
- Decline the authorization.
decline:
additionalProperties: false
description: If your application declines the authorization, this contains details about the decline.
properties:
reason:
description: The reason the card authorization was declined. This translates to a specific decline code that is sent to the card network.
enum:
- insufficient_funds
- transaction_never_allowed
- exceeds_approval_limit
- card_temporarily_disabled
- suspected_fraud
- other
type: string
x-documentation-priority: default
x-enum-descriptions:
- The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again.
- This type of transaction is not allowed for this card. This transaction should not be retried.
- The transaction amount exceeds the cardholder's approval limit. The merchant may attempt to process the transaction again.
- The card has been temporarily disabled or not yet activated. The merchant may attempt to process the transaction again.
- The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again.
- The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly.
required:
- reason
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
required:
- decision
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
card_balance_inquiry:
additionalProperties: false
description: If the Real-Time Decision relates to a card balance inquiry attempt, this object contains your response to the inquiry.
properties:
approval:
additionalProperties: false
description: If your application approves the balance inquiry, this contains metadata about your decision to approve.
properties:
balance:
description: The balance on the card in the settlement currency of the transaction.
minimum: 0
type: integer
x-documentation-priority: default
required:
- balance
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
decision:
description: Whether the card balance inquiry should be approved or declined.
enum:
- approve
- decline
type: string
x-documentation-priority: default
x-enum-descriptions:
- Approve the authorization.
- Decline the authorization.
required:
- decision
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
digital_wallet_authentication:
additionalProperties: false
description: If the Real-Time Decision relates to a digital wallet authentication attempt, this object contains your response to the authentication.
properties:
result:
description: Whether your application was able to deliver the one-time passcode.
enum:
- success
- failure
type: string
x-documentation-priority: default
x-enum-descriptions:
- Your application successfully delivered the one-time passcode to the cardholder.
- Your application failed to deliver the one-time passcode to the cardholder.
success:
additionalProperties: false
description: If your application was able to deliver the one-time passcode, this contains metadata about the delivery. Exactly one of `phone` or `email` must be provided.
properties:
email:
description: The email address that was used to verify the cardholder via one-time passcode.
format: email
maxLength: 200
minLength: 1
type: string
x-documentation-priority: default
phone:
description: The phone number that was used to verify the cardholder via one-time passcode over SMS.
maxLength: 200
minLength: 1
type: string
x-documentation-priority: default
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
required:
- result
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
digital_wallet_token:
additionalProperties: false
description: If the Real-Time Decision relates to a digital wallet token provisioning attempt, this object contains your response to the attempt.
properties:
approval:
additionalProperties: false
description: If your application approves the provisioning attempt, this contains metadata about the digital wallet token that will be generated.
properties:
email:
description: An email address that can be used to verify the cardholder via one-time passcode.
format: email
maxLength: 200
minLength: 1
type: string
x-documentation-priority: default
phone:
description: A phone number that can be used to verify the cardholder via one-time passcode over SMS.
maxLength: 200
minLength: 1
type: string
x-documentation-priority: default
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
decline:
additionalProperties: false
description: If your application declines the provisioning attempt, this contains details about the decline.
properties:
reason:
description: Why the tokenization attempt was declined. This is for logging purposes only and is not displayed to the end-user.
maxLength: 200
minLength: 1
type: string
x-documentation-priority: default
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
type: object
x-event-categories: []
x-stainless-empty-object: false
real_time_decision:
additionalProperties: false
description: Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. For more information, see our [Real-Time Decisions guide](https://increase.com/documentation/real-time-decisions).
example:
card_authentication: null
card_authentication_challenge: null
card_authorization:
account_id: account_in71c4amph0vgo2qllky
additional_amounts:
clinic: null
dental: null
original: null
prescription: null
surcharge: null
total_cumulative: null
total_healthcare: null
transit: null
unknown: null
vision: null
approval: null
card_id: card_oubs0hwk5rn6knuecxg2
decision: approve
decline: null
digital_wallet_token_id: null
direction: settlement
merchant_acceptor_id: '5665270011000168'
merchant_category_code: '5734'
merchant_city: New York
merchant_country: US
merchant_descriptor: AMAZON.COM
merchant_postal_code: '10045'
merchant_state: NY
network_details:
category: visa
pulse: null
visa:
electronic_commerce_indicator: secure_electronic_commerce
point_of_service_entry_mode: manual
stand_in_processing_reason: null
terminal_entry_capability: magnetic_stripe
network_identifiers:
authorization_identification_response: null
retrieval_reference_number: '785867080153'
trace_number: '487941'
transaction_id: '627199945183184'
network_risk_score: 10
partial_approval_capability: not_supported
physical_card_id: null
presentment_amount: 100
presentment_currency: USD
processing_category: purchase
request_details:
category: initial_authorization
incremental_authorization: null
initial_authorization: {}
settlement_amount: 100
settlement_currency: USD
terminal_id: RCN5VNXS
upcoming_card_payment_id: card_payment_nd3k2kacrqjli8482ave
verification:
card_verification_code:
result: match
cardholder_address:
actual_line1: 33 Liberty Street
actual_postal_code: '94131'
provided_line1: 33 Liberty Street
provided_postal_code: '94132'
result: postal_code_no_match_address_match
cardholder_name: null
card_balance_inquiry: null
category: card_authorization_requested
created_at: '2020-01-31T23:59:59Z'
digital_wallet_authentication: null
digital_wallet_token: null
id: real_time_decision_j76n2e810ezcg3zh5qtn
status: pending
timeout_at: '2020-01-31T23:59:59Z'
type: real_time_decision
properties:
card_authentication:
anyOf:
- additionalProperties: false
description: Fields related to a 3DS authentication attempt.
properties:
access_control_server_transaction_identifier:
description: A unique identifier assigned by the Access Control Server (us) for this transaction.
type: string
x-documentation-priority: default
account_id:
description: The identifier of the Account the card belongs to.
type: string
x-documentation-priority: default
x-id-reference-to: Accounts
billing_address_city:
anyOf:
- description: The city of the cardholder billing address associated with the card used for this purchase.
type: string
x-documentation-priority: default
- type: 'null'
billing_address_country:
anyOf:
- description: The country of the cardholder billing address associated with the card used for this purchase.
type: string
x-documentation-priority: default
- type: 'null'
billing_address_line1:
anyOf:
- description: The first line of the cardholder billing address associated with the card used for this purchase.
type: string
x-documentation-priority: default
- type: 'null'
billing_address_line2:
anyOf:
- description: The second line of the cardholder billing address associated with the card used for this purchase.
type: string
x-documentation-priority: default
- type: 'null'
billing_address_line3:
anyOf:
- description: The third line of the cardholder billing address associated with the card used for this purchase.
type: string
x-documentation-priority: default
- type: 'null'
billing_address_postal_code:
anyOf:
- description: The postal code of the cardholder billing address associated with the card used for this purchase.
type: string
x-documentation-priority: default
- type: 'null'
billing_address_state:
anyOf:
- description: The US state of the cardholder billing address associated with the card used for this purchase.
type: string
x-documentation-priority: default
- type: 'null'
card_id:
description: The identifier of the Card.
type: string
x-documentation-priority: default
x-id-reference-to: Cards
cardholder_email:
anyOf:
- description: The email address of the cardholder.
type: string
x-documentation-priority: default
- type: 'null'
cardholder_name:
anyOf:
- description: The name of the cardholder.
type: string
x-documentation-priority: default
- type: 'null'
decision:
anyOf:
- description: Whether or not the authentication attempt was approved.
enum:
- approve
- challenge
- deny
type: string
x-documentation-priority: default
x-enum-descriptions:
- Approve the authentication attempt without triggering a challenge.
- Request further validation before approving the authentication attempt.
- Deny the authentication attempt.
- type: 'null'
device_channel:
additionalProperties: false
description: The device channel of the card authentication attempt.
properties:
browser:
anyOf:
- additionalProperties: false
description: Fields specific to the browser device channel.
properties:
accept_header:
anyOf:
- description: The accept header from the cardholder's browser.
type: string
x-documentation-priority: default
- type: 'null'
ip_address:
anyOf:
- description: The IP address of the cardholder's browser.
type: string
x-documentation-priority: default
- type: 'null'
javascript_enabled:
anyOf:
- description: Whether JavaScript is enabled in the cardholder's browser.
enum:
- enabled
- disabled
type: string
x-documentation-priority: default
x-enum-desc
# --- truncated at 32 KB (151 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/increase/refs/heads/main/openapi/increase-real-time-decisions-api-openapi.yml