The simulate API from Marqeta — 10 operation(s) for simulate.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/marqeta-simulate-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
contact:
email: support@marqeta.com
name: Marqeta
description: Marqeta's Core API endpoints, conveniently annotated to enable code generation (including SDKs), test cases, and documentation. Currently in beta.
termsOfService: https://www.marqeta.com/api-terms
title: Core accepted countries Simulate API
version: 3.0.39
servers:
- url: /v3
security:
- mqAppAndAccessToken: []
tags:
- name: simulate
paths:
/simulate/authorization:
post:
operationId: postSimulateAuthorization
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth_request_model'
required: false
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/simulation_response_model'
description: Success
'400':
content: {}
description: User input error/Bad request
'500':
content: {}
description: Server error
summary: Simulates an authorization
tags:
- simulate
/simulate/authorization/advice:
post:
operationId: postSimulateAuthorizationAdvice
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/authorization_advice_model'
required: false
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/simulation_response_model'
description: Success
'400':
content: {}
description: User input error/Bad request
'404':
content: {}
description: Original transaction not found
'500':
content: {}
description: Server error
summary: Simulates an authorization advice transaction
tags:
- simulate
/simulate/clearing:
post:
operationId: postSimulateClearing
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClearingModel'
required: false
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/simulation_response_model'
description: Success
'400':
content: {}
description: User input error/Bad request
'404':
content: {}
description: Original transaction not found
'500':
content: {}
description: Server error
summary: Simulates a clearing/settlement transaction
tags:
- simulate
/simulate/directdeposits:
post:
operationId: postSimulateDirectdeposits
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DirectDepositRequest'
description: Direct deposit simulate request model
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DepositDepositResponse'
description: Success
'400':
content: {}
description: Bad request
'500':
content: {}
description: Server error
summary: Simulates the creation of direct deposit
tags:
- simulate
/simulate/financial:
post:
operationId: postSimulateFinancial
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/financial_request_model'
description: Financial request model
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/simulation_response_model'
description: Success
'400':
content: {}
description: User input error/Bad request
'500':
content: {}
description: Server error
summary: Simulates a financial request (PIN debit) transaction with optional cash back
tags:
- simulate
/simulate/financial/advice:
post:
operationId: postSimulateFinancialAdvice
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/authorization_advice_model'
description: Financial advice request model
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/simulation_response_model'
description: Success
'400':
content: {}
description: User input error/Bad request
'404':
content: {}
description: Original transaction not found
'500':
content: {}
description: Server error
summary: Simulates a financial advice transaction
tags:
- simulate
/simulate/financial/balanceinquiry:
post:
operationId: postSimulateFinancialBalanceinquiry
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/balance_inquiry_request_model'
description: Balance inquiry request model
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/simulation_response_model'
description: Success
'400':
content: {}
description: User input error/Bad request
'500':
content: {}
description: Server error
summary: Simulates a balance inquiry
tags:
- simulate
/simulate/financial/originalcredit:
post:
operationId: postSimulateFinancialOriginalcredit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/orignalcredit_request_model'
description: Orignal Credit request model
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/simulation_response_model'
description: Success
'400':
content: {}
description: User input error/Bad request
'500':
content: {}
description: Server error
summary: Simulates an orignal credit transaction
tags:
- simulate
/simulate/financial/withdrawal:
post:
operationId: postSimulateFinancialWithdrawal
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/withdrawal_request_model'
description: ATM withdrawal request model
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/simulation_response_model'
description: Success
'400':
content: {}
description: User input error/Bad request
'500':
content: {}
description: Server error
summary: Simulates an ATM withdrawal transaction
tags:
- simulate
/simulate/reversal:
post:
operationId: postSimulateReversal
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReversalModel'
required: false
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/simulation_response_model'
description: Success
'400':
content: {}
description: User input error/Bad request
'404':
content: {}
description: Original transaction not found
'500':
content: {}
description: Server error
summary: Simulates a reversal transaction
tags:
- simulate
components:
schemas:
text_value:
properties:
value:
description: Line of personalized text printed on the card.
type: string
type: object
jit_address_verification:
description: Contains address verification data used to make JIT Funding decisions.
properties:
gateway:
$ref: '#/components/schemas/address_verification_source'
issuer:
$ref: '#/components/schemas/address_verification_source'
request:
$ref: '#/components/schemas/avs_information'
type: object
auto_reload_model:
description: 'Contains information about an auto reload.
See <</core-api/auto-reload, Auto Reloads>> for more information.
Returned if an auto reload was executed.'
properties:
active:
default: true
description: 'Specifies whether the auto reload is active.
Only one auto reload per level, per object, can be active.'
type: boolean
association:
$ref: '#/components/schemas/auto_reload_association'
currency_code:
description: Three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"].
type: string
funding_source_address_token:
description: 'Unique identifier of the funding source address to use for this auto reload.
If your funding source is an ACH account, then a `funding_source_address_token` is not required.
If your funding source is a payment card, you must have at least one funding source address in order to create a GPA order.
Send a `GET` request to `/fundingsources/addresses/user/{user_token}` to retrieve address tokens for a user.
Send a `GET` request to `/fundingsources/addresses/business/{business_token}` to retrieve address tokens for a business.'
maxLength: 36
minLength: 1
type: string
funding_source_token:
description: 'Unique identifier of the funding source to use for this auto reload.
Send a `GET` request to `/fundingsources/user/{user_token}` to retrieve funding source tokens for a user.
Send a `GET` request to `/fundingsources/business/{business_token}` to retrieve funding source tokens for a business.'
maxLength: 36
minLength: 1
type: string
order_scope:
$ref: '#/components/schemas/order_scope'
token:
description: 'Unique identifier of the auto reload.
If you do not include a token, the system will generate one automatically.
This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember.
This value cannot be updated.'
maxLength: 36
minLength: 1
type: string
required:
- currency_code
- order_scope
type: object
pos:
description: 'Contains information about the point of sale, including details on how the card was presented.
Returned if provided by the card network, and the request uses Transaction Model v2 of the Marqeta Core API.
Not returned for Transaction Model v1 requests.'
properties:
card_data_input_capability:
description: How the terminal accepts card data.
enum:
- UNKNOWN
- NO_TERMINAL
- MAG_STRIPE
- MAG_STRIPE_CONTACTLESS
- MAG_STRIPE_KEY_ENTRY
- CHIP
- CHIP_CONTACTLESS
- CHIP_MAG_STRIPE
- CHIP_MAG_STRIPE_KEY_ENTRY
- KEY_ENTRY
- OCR
- MICR
- BAR_CODE
- CREDENTIALS_ON_FILE
type: string
card_holder_presence:
default: false
description: Whether the cardholder was present during the transaction.
type: boolean
card_presence:
default: false
description: Whether the card was present during the transaction.
type: boolean
cardholder_authentication_method:
description: Method used to authenticate the cardholder.
enum:
- UNSPECIFIED
- NON_AUTHENTICATED
- SIGNATURE
- PIN
- ID_VERIFIED
- ELECTRONIC_SIGNATURE
- BIOMETRIC
- BIOGRAPHIC
- MANUAL_SIGNATURE
- ELECTRONIC_TICKET_ENVIRONMENT
type: string
country_code:
description: Country code of the card acceptor or terminal.
type: string
county:
description: County of the card acceptor or terminal.
type: string
is_installment:
default: false
description: Whether the transaction is an installment payment.
type: boolean
is_recurring:
default: false
description: Whether the transaction is recurring.
type: boolean
pan_entry_mode:
description: Method used for capturing the card primary account number (PAN) during the transaction.
enum:
- UNKNOWN
- MANUAL
- MAG_STRIPE
- MAG_STRIPE_CONTACTLESS
- BAR_CODE
- OCR
- MICR
- CHIP
- CHIP_CONTACTLESS
- CARD_ON_FILE
- CHIP_FALLBACK
- OTHER
- KEY_ENTERED
- CREDENTIALS_ON_FILE
- KEYED_CARD_PCSC
- MAG_STRIPE_READ_KEYED_PCSC
type: string
partial_approval_capable:
default: false
description: Indicates whether the card acceptor or terminal supports partial-approval transactions.
type: boolean
pin_entry_mode:
description: 'Indicates whether the card acceptor or terminal can capture card personal identification numbers (PINs).
*NOTE:* This field does not indicate whether a PIN was entered.'
enum:
- UNKNOWN
- 'TRUE'
- 'FALSE'
- DEFECTIVE
type: string
pin_present:
default: false
description: Indicates whether the cardholder entered a PIN during the transaction.
type: boolean
purchase_amount_only:
default: false
description: Indicates whether the card acceptor or terminal supports purchase-only approvals.
type: boolean
special_condition_indicator:
description: 'Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction.
These transactions typically involve non-financial institutions.'
enum:
- UNSPECIFIED
- CRYPTOCURRENCY_PURCHASE
- QUASI_CASH
- DEBT_PAYMENT
- CENTRAL_BANK_DIGITAL_CURRENCY_PURCHASE
- STABLECOIN_PURCHASE
- BLOCKCHAIN_NATIVE_TOKEN_PURCHASE
- NON_FUNGIBLE_TOKEN_PURCHASE
type: string
state:
description: State, province, or territory of the card acceptor or terminal.
type: string
terminal_attendance:
description: Whether the card acceptor/terminal was attended.
enum:
- UNSPECIFIED
- ATTENDED
- UNATTENDED
- NO_TERMINAL
- MOBILE_REMOTE
- TRANSIT_ACCESS_TERMINAL
type: string
terminal_id:
description: Card acceptor or terminal identification number.
type: string
terminal_location:
description: Location of the card acceptor/terminal.
enum:
- ON_PREMISE
- ON_PREMISE_CARDHOLDER
- OFF_PREMISE_CARDHOLDER
- ON_PREMISE_MERCHANT
- OFF_PREMISE_MERCHANT
- NO_TERMINAL
- MOBILE_REMOTE
- TRANSIT_ACCESS_TERMINAL
- UNSPECIFIED
type: string
terminal_type:
description: Type of card acceptor/terminal.
enum:
- AUTO_DISPENSER_WITH_PIN
- SELF_SERVICE
- LIMITED_AMOUNT
- IN_FLIGHT
- ECOMMERCE
- TRANSPONDER
type: string
transaction_initiated_by:
description: Specifies the initiator of the transaction.
enum:
- CONSUMER
- MERCHANT
- UNKNOWN
- MARQETA
- NETWORK
type: string
transaction_initiated_category:
description: Specifies the category of a point-of-sale transaction.
enum:
- CARD_ON_FILE
- RECURRING_VAR_AMT_FIXED_FREQ
- RECURRING_PAYMENT
- INSTALLMENT_PAYMENT
- UNSCHEDULED_PAYMENT
- PARTIAL_SHIPMENT
- DELAYED_PAYMENT
- NO_SHOW
- RESUBMISSION
- DEFERRED_BILLING
- ACCOUNT_INQUIRY
- INCREMENTAL_AUTHORIZATION
- REAUTHORIZATION
type: string
zip:
description: United States ZIP code of the card acceptor or terminal.
type: string
type: object
CardFulfillmentResponse:
description: Determines physical characteristics of a card and shipment information.
properties:
card_fulfillment_reason:
description: Descriptive reason for the card fulfillment.
enum:
- NEW
- LOST_STOLEN
- EXPIRED
type: string
card_personalization:
$ref: '#/components/schemas/card_personalization'
shipping:
$ref: '#/components/schemas/ShippingInformationResponse'
required:
- card_personalization
type: object
wallet_provider_profile:
description: Contains information held and provided by the digital wallet provider.
properties:
account:
$ref: '#/components/schemas/account'
device_score:
description: Score from the device.
type: string
pan_source:
description: Source from which the digital wallet provider obtained the card primary account number (PAN).
type: string
reason_code:
description: 'Reason for the wallet provider''s provisioning decision.
* *01* – Cardholder''s wallet account is too new relative to launch.
* *02* – Cardholder''s wallet account is too new relative to provisioning request.
* *03* – Cardholder''s wallet account/card pair is newer than date threshold.
* *04* – Changes made to account data within the account threshold.
* *05* – Suspicious transactions linked to this account.
* *06* – Account has not had activity in the last year.
* *07* – Suspended cards in the secure element.
* *08* – Device was put in lost mode in the last seven days for longer than the duration threshold.
* *09* – The number of provisioning attempts on this device in 24 hours exceeds threshold.
* *0A* – There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours.
* *0B* – The card provisioning attempt contains a distinct name in excess of the threshold.
* *0C* – The device score is less than 3.
* *0D* – The account score is less than 4.
* *0E* – Device provisioning location outside of the cardholder''s wallet account home country.
* *0G* – Suspect fraud.'
type: string
recommendation_reasons:
description: Array of recommendation reasons from the digital wallet provider.
items:
type: string
type: array
risk_assessment:
$ref: '#/components/schemas/risk_assessment'
type: object
flex:
description: Contains information about a Flexible Credential transaction.
properties:
action:
description: Indicates whether the Flexible Credential transaction object is actionable (`inquiry`) or merely informative (`advice`).
enum:
- inquiry
- advice
type: string
eligible:
description: Indicates whether or not the transaction is eligible for Flexible Credential transactions.
type: string
eligible_products:
description: 'Specifies which of the payment instrument''s credentials is eligible for this transaction:
* A value of `DEBIT` indicates the primary credential.
* A value of `LOAN` indicates the secondary credential.'
items:
type: string
type: array
secondary_credential_identifier:
description: Identifies the secondary credential used in the transaction, if applicable.
type: string
selected_product:
description: Indicates the eligible product that was used in the transaction.
type: string
type: object
orignalcredit_request_model:
properties:
amount:
type: number
card_acceptor:
$ref: '#/components/schemas/card_acceptor_model'
card_token:
maxLength: 36
minLength: 1
type: string
mid:
maxLength: 50
minLength: 1
type: string
screening_score:
type: string
sender_data:
$ref: '#/components/schemas/original_credit_sender_data'
transactionPurpose:
type: string
type:
enum:
- account_to_account
- person_to_person
- prepaid
- wallet_transfer
- money_transfer_by_bank
- business_to_business
- disbursement
- government_disbursement
- gambling_payout
- loyalty
- merchant_disbursement
- online_gambling_payout
- pension_disbursement
- prepaid_loads
- card_bill_payment
- bill_payment
- cash_claim
- cash_in
- cash_out
- mobile_air_time_payment
- money_transfer_by_merchant
- face_to_face_merchant_payment
- government_payment
- payments_goods_services
- purchase_repayment
- visa_accept
type: string
webhook:
$ref: '#/components/schemas/webhook'
required:
- amount
- card_token
- mid
- type
type: object
ClearingModel:
properties:
amount:
type: number
card_acceptor:
$ref: '#/components/schemas/card_acceptor_model'
force_post:
default: false
type: boolean
is_refund:
default: false
type: boolean
mid:
maxLength: 50
minLength: 1
type: string
network_fees:
items:
$ref: '#/components/schemas/network_fee_model'
type: array
original_transaction_token:
maxLength: 36
minLength: 1
type: string
vcn_data:
$ref: '#/components/schemas/vcn_data_model'
webhook:
$ref: '#/components/schemas/webhook'
required:
- amount
- original_transaction_token
type: object
program_transfer_response:
description: Contains information about a program transfer, which moves funds from an account holder's GPA to a program funding source.
properties:
amount:
description: Amount of program transfer.
type: number
business_token:
description: 'Unique identifier of the business account holder.
Returned if `user_token` is not specified.'
maxLength: 36
minLength: 1
type: string
created_time:
description: Date and time when the program transfer object was created, in UTC.
format: date-time
type: string
currency_code:
description: Three-digit ISO 4217 currency code.
type: string
fees:
description: Contains attributes that define characteristics of one or more fees.
items:
$ref: '#/components/schemas/fee_detail'
type: array
jit_funding:
$ref: '#/components/schemas/jit_funding_api'
memo:
description: Additional description of the program transfer.
maxLength: 99
minLength: 1
type: string
tags:
description: Comma-delimited list of tags describing the program transfer.
maxLength: 255
minLength: 1
type: string
token:
description: Unique identifier of the program transfer.
maxLength: 36
minLength: 1
type: string
transaction_token:
description: Unique identifier of the transaction.
type: string
type_token:
description: Unique identifier of the program transfer type.
maxLength: 36
minLength: 1
type: string
user_token:
description: 'Unique identifier of the user account holder.
Returned if `business_token` is not specified.'
maxLength: 36
minLength: 1
type: string
required:
- amount
- currency_code
- transaction_token
- type_token
type: object
installment_data:
description: Contains the installment plan identifier used by the Visa Transaction Matching Service for Issuers.
properties:
installment_plan_identifier:
description: '(_Visa only_) Visa Transaction Matching Service for Issuers identifier.
This identifier matches a transaction on the Marqeta platform to an installment plan or Pay by Points transaction on the Visa card network.'
type: string
type: object
card_acceptor_model:
properties:
address:
maxLength: 255
minLength: 0
type: string
business_registration_id:
type: string
business_registration_id_type:
type: string
city:
maxLength: 40
minLength: 0
type: string
country:
type: string
customer_service_phone:
type: string
ecommerce_security_level_indicator:
type: string
geographic_coordinates:
type: string
legal_business_name:
type: string
mcc:
maxLength: 5
minLength: 0
type: string
name:
maxLength: 50
minLength: 0
type: string
partial_approval_capable:
default: false
type: boolean
phone:
type: string
service_geographic_coordinates:
type: string
state:
type: string
url:
type: string
zip:
maxLength: 10
minLength: 0
type: string
type: object
issuer_fraud_view:
description: Contains one or more fraud determinations by the card network that apply to either the transaction or the cardholder's account.
properties:
fraud_score_reasons:
items:
type: string
type: array
recommended_action:
description: The action recommended based on the fraud score.
type: string
risk_level:
description: The fraud rating, or level of risk associated with the transaction.
type: string
riskcontrol_tags:
description: The RiskControl tags that were triggered by the transaction.
items:
$ref: '#/components/schemas/riskcontrol_tags'
type: array
rule_violations:
description: The rules violated by the transaction.
items:
type: string
type: array
score:
description: 'The risk score generated by RiskControl.
This is either the Mastercard Decision Intelligence or Visa Advance Authorization transaction risk score.'
format: int32
type: integer
triggered_rules:
description: Provides a list of rules triggered by a fraud event, along with the information on tags and rule characteristics.
items:
$ref: '#/components/schemas/triggered_rule'
type: array
type: object
text:
description: Specifies personalized text that appears on the card.
properties:
name_line_1:
$ref: '#/components/schemas/text_value'
name_line_2:
$ref: '#/components/schemas/text_value'
name_line_3:
$ref: '#/components/schemas/text_value'
required:
- name_line_1
type: object
account_balance:
properties:
balances:
additionalProperties:
$ref: '#/components/schemas/CurrencyBalance'
type: object
default_currency_code:
type: string
description:
type: string
impacted_amount:
type: number
last_updated_time:
format: date-time
type: string
token:
type: string
type:
type: string
type: object
triggered_rule:
description: Provides a list of rules triggered by a fraud event, along with the information on tags and rule characteristics.
properties:
alert:
description: Indicates if the rule triggered an alert.
type: boolean
entity_type:
description: The entity type where the triggered rule was defined.
type: string
rule_name:
description: Name of the rule, as defined in the Real-Time Decisioning dashboard that was triggered.
type: string
suppress_alert:
description: Indicates if the triggered rule has `suppress_alert` in the definition.
type: boolean
tags:
description: All the tags defined in the triggered rule.
items:
$ref: '#/components/schemas/tag'
type: array
type: object
auth_request_model:
properties:
amount:
type: number
card_acceptor:
$ref: '#/components/schemas/card_acceptor_model'
card_options:
$ref: '#/components/schemas/card_options'
card_token:
maxLength: 36
minLength: 1
type: string
cash_back_amount:
type: number
is_pre_auth:
default: false
type: boolean
mid:
maxLength: 50
minLength: 1
type: string
network_fees:
items:
$ref: '#/components/schemas/network_fee_model'
type: array
network_metadata:
$ref: '#/components/schemas/network_metadata'
pin:
maxLength: 50
minLength: 1
type: string
transaction_options:
$ref: '#/components/schemas/transaction_options'
vcn_data:
$ref: '#/components/schemas/vcn_data_model'
webhook:
$ref: '#/components/schemas/webhook'
required:
- amount
- card_token
- mid
type: object
images_card:
description: Specifies personalized images that appear on the card.
properties:
name:
description: Specifies a PNG image to display on the card.
type: string
thermal_color:
description: Specifies the color of the image displayed on the card.
type: string
type: object
riskcontrol_tags:
description: The RiskControl tags that were triggered by the transaction.
properties:
rule_name:
description: Name of the rule, as defined in the Real-Time Decisioning dashboard, that was triggered.
type: string
tag:
description: Tag name defined in the rule definition in the Real-Time Decisioning dashboard.
type: string
values:
description: Value associated with the tag.
items:
type: string
type: array
type: object
user_card_holder_response:
description: Contains information about a cardholder.
properties:
account_holder_group_token:
# --- truncated at 32 KB (189 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/marqeta/refs/heads/main/openapi/marqeta-simulate-api-openapi.yml