Increase Real Time Decisions API
The Real Time Decisions API from Increase — 2 operation(s) for real time decisions.
OpenAPI Specification
openapi: 3.1.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 Account Numbers 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:
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-descriptions:
- JavaScript is enabled in the cardholder's browser.
- JavaScript is not enabled in the cardholder's browser.
- type: 'null'
language:
anyOf:
- description: The language of the cardholder's browser.
type: string
x-documentation-priority: default
- type: 'null'
user_agent:
anyOf:
- description: The user agent of the cardholder's browser.
type: string
x-documentation-priority: default
- type: 'null'
required:
- accept_header
- ip_address
- javascript_enabled
- language
- user_agent
title: Real-Time Decision CardAuthentication DeviceChannel Browser
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Browsers
- type: 'null'
category:
description: The category of the device channel.
enum:
- app
- browser
- three_ds_requestor_initiated
type: string
x-documentation-priority: default
x-enum-descriptions:
- The authentication attempt was made from an app.
- The authentication attempt was made from a browser.
- The authentication attempt was initiated by the 3DS Requestor.
merchant_initiated:
anyOf:
- additionalProperties: false
description: Fields specific to merchant initiated transactions.
properties:
indicator:
description: The merchant initiated indicator for the transaction.
enum:
- recurring_transaction
- installment_transaction
- add_card
- maintain_card_information
- account_verification
- split_delayed_shipment
- top_up
- mail_order
- telephone_order
- whitelist_status_check
- other_payment
- billing_agreement
- device_binding_status_check
- card_security_code_status_check
- delayed_shipment
- split_payment
- fido_credential_deletion
- fido_credential_registration
- decoupled_authentication_fallback
type: string
x-documentation-priority: default
x-enum-descriptions:
- Recurring transaction.
- Installment transaction.
- Add card.
- Maintain card information.
- Account verification.
- Split or delayed shipment.
- Top up.
- Mail order.
- Telephone order.
- Whitelist status check.
- Other payment.
- Billing agreement.
- Device binding status check.
- Card security code status check.
- Delayed shipment.
- Split payment.
- FIDO credential deletion.
- FIDO credential registration.
- Decoupled authentication fallback.
required:
- indicator
title: Real-Time Decision CardAuthentication DeviceChannel MerchantInitiated
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: MerchantInitiateds
- type: 'null'
required:
- category
- merchant_initiated
- browser
title: Real-Time Decision CardAuthentication DeviceChannel
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
directory_server_transaction_identifier:
description: A unique identifier assigned by the Directory Server (the card network) for this transaction.
type: string
x-documentation-priority: default
merchant_acceptor_id:
anyOf:
- description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
type: string
x-documentation-priority: default
- type: 'null'
merchant_category_code:
anyOf:
- description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
type: string
x-documentation-priority: default
- type: 'null'
merchant_country:
anyOf:
- description: The country the merchant resides in.
type: string
x-documentation-priority: default
- type: 'null'
merchant_name:
anyOf:
- description: The name of the merchant.
type: string
x-documentation-priority: default
- type: 'null'
message_category:
additionalProperties: false
description: The message category of the card authentication attempt.
properties:
category:
description: The category of the card authentication attempt.
enum:
- payment_authentication
- non_payment_authentication
type: string
x-documentation-priority: default
x-enum-descriptions:
- The authentication attempt is for a payment.
- The authentication attempt is not for a payment.
non_payment:
anyOf:
- additionalProperties: false
description: Fields specific to non-payment authentication attempts.
properties: {}
title: Real-Time Decision CardAuthentication MessageCategory NonPayment
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: true
x-title-plural: NonPayments
- type: 'null'
payment:
anyOf:
- additionalProperties: false
description: Fields specific to payment authentication attempts.
properties:
purchase_amount:
description: The purchase amount in minor units.
type: integer
x-documentation-priority: default
purchase_amount_cardholder_estimated:
anyOf:
- description: The purchase amount in the cardholder's currency (i.e., USD) estimated using daily conversion rates from the card network.
type: integer
x-documentation-priority: default
- type: 'null'
purchase_currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authentication attempt's purchase currency.
type: string
x-documentation-priority: default
transaction_type:
anyOf:
- description: The type of transaction being authenticated.
enum:
- goods_service_purchase
- check_acceptance
- account_funding
- quasi_cash_transaction
- prepaid_activation_and_load
type: string
x-documentation-priority: default
x-enum-descriptions:
- Purchase of goods or services.
- Check acceptance.
- Account funding.
- Quasi-cash transaction.
- Prepaid activation and load.
- type: 'null'
required:
- purchase_amount
- purchase_currency
- purchase_amount_cardholder_estimated
- transaction_type
title: Real-Time Decision CardAuthentication MessageCategory Payment
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Payments
- type: 'null'
required:
- category
- payment
- non_payment
title: Real-Time Decision CardAuthentication MessageCategory
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
prior_authenticated_card_payment_id:
anyOf:
- description: The ID of a prior Card Authentication that the requestor used to authenticate this cardholder for a previous transaction.
type: string
x-documentation-priority: default
x-id-reference-to: Card Authentications
- type: 'null'
requestor_authentication_indicator:
anyOf:
- description: The 3DS requestor authentication indicator describes why the authentication attempt is performed, such as for a recurring transaction.
enum:
- payment_transaction
- recurring_transaction
- installment_transaction
- add_card
- maintain_card
- emv_token_cardholder_verification
- billing_agreement
type: string
x-documentation-priority: default
x-enum-descriptions:
- The authentication is for a payment transaction.
- The authentication is for a recurring transaction.
- The authentication is for an installment transaction.
- The authentication is for adding a card.
- The authentication is for maintaining a card.
- The authentication is for EMV token cardholder verification.
- The authentication is for a billing agreement.
- type: 'null'
requestor_challenge_indicator:
anyOf:
- description: Indicates whether a challenge is requested for this transaction.
enum:
- no_preference
- no_challenge_requested
- challenge_requested_3ds_requestor_preference
- challenge_requested_mandate
- no_challenge_requested_transactional_risk_analysis_already_performed
- no_challenge_requested_data_share_only
- no_challenge_requested_strong_consumer_authentication_already_performed
- no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required
- challenge_requested_whitelist_prompt_requested_if_challenge_required
type: string
x-documentation-priority: default
x-enum-descriptions:
- No preference.
- No challenge requested.
- Challenge requested, 3DS Requestor preference.
- Challenge requested, mandate.
- No challenge requested, transactional risk analysis already performed.
- No challenge requested, data share only.
- No challenge requested, strong consumer authentication already performed.
- No challenge requested, utilize whitelist exemption if no challenge required.
- Challenge requested, whitelist prompt requested if challenge required.
- type: 'null'
requestor_name:
description: The name of the 3DS requestor.
type: string
x-documentation-priority: default
requestor_url:
description: The URL of the 3DS requestor.
type: string
x-documentation-priority: default
shipping_address_city:
anyOf:
- description: The city of the shipping address associated with this purchase.
type: string
x-documentation-priority: default
- type: 'null'
shipping_address_country:
anyOf:
- description: The country of the shipping address associated with this purchase.
type: string
x-documentation-priority: default
- type: 'null'
shipping_address_line1:
anyOf:
- description: The first line of the shipping address associated with this purchase.
type: string
x-documentation-priority: default
- type: 'null'
shipping_address_line2:
anyOf:
- description: The second line of the shipping address associated with this purchase.
type: string
x-documentation-priority: default
- type: 'null'
shipping_address_line3:
anyOf:
- description: The third line of the shipping address associated with this purchase.
type: string
x-documentation-priority: default
- type: 'null'
shipping_address_postal_code:
anyOf:
- description: The postal code of the shipping address associated with this purchase.
type: string
x-documentation-priority: default
- type: 'null'
shipping_address_state:
anyOf:
- description: The US state of the shipping address associated with this purchase.
type: string
x-documentation-priority: default
- type: 'null'
three_d_secure_server_transaction_identifier:
description: A unique identifier assigned by the 3DS Server initiating the authentication attempt for this transaction.
type: string
x-documentation-priority: default
upcoming_card_payment_id:
description: The identifier of the Card Payment this authentication attempt will belong to. Available in the API once the card authentication has completed.
type: string
x-documentation-priority: default
x-id-reference-to: Card Payments
required:
- card_id
- prior_authenticated_card_payment_id
- message_category
- access_control_server_transaction_identifier
- three_d_secure_server_transaction_identifier
- directory_server_transaction_identifier
- device_channel
- cardholder_name
- cardholder_email
- requestor_authentication_indicator
- requestor_challenge_indicator
- requestor_name
- requestor_url
- merchant_category_code
- merchant_acceptor_id
- merchant_name
- merchant_country
- billing_address_line1
- billing_address_line2
- billing_address_line3
- billing_address_city
- billing_address_state
- billing_address_postal_code
- billing_address_country
- shipping_address_line1
- shipping_address_line2
- shipping_address_line3
- shipping_address_city
- shipping_address_state
- shipping_address_postal_code
- shipping_address_country
- account_id
- upcoming_card_payment_id
- decision
title: Real-Time Decision CardAuthentication
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: CardAuthentications
- type: 'null'
card_authentication_challenge:
anyOf:
- additionalProperties: false
description: Fields related to a 3DS authentication attempt.
properties:
account_id:
description: The identifier of the Account the card belongs to.
type: string
x-documentation-priority: default
x-id-reference-to: Accounts
card_id:
description: The identifier of the Card that is being tokenized.
type: string
x-documentation-priority: default
x-id-reference-to: Cards
card_payment_id:
description: The identifier of the Card Payment this authentication challenge attempt belongs to.
type: string
x-documentation-priority: default
x-id-reference-to: Card Payments
one_time_code:
description: The one-time code delivered to the cardholder.
type: string
x-documentation-priority: default
result:
anyOf:
- description: Whether or not the challenge was 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.
- type: 'null'
required:
- card_id
- account_id
- card_payment_id
- one_time_code
- result
title: Real-Time Decision CardAuthenticationChallenge
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: CardAuthenticationChallenges
- type: 'null'
card_authorization:
anyOf:
- additionalProperties: true
description: Fields related to a card authorization.
properties:
account_id:
description: The identifier of the Account the authorization will debit.
type: string
x-documentation-priority: default
x-id-reference-to: Accounts
additional_amounts:
additionalProperties: false
description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are use
# --- 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