--- title: "Simulate authorization clearing" method: POST path: "/simulations/cardtransactions/authorization.clearing" tags: ["Simulations 2.0 — Card Transactions"] --- # Simulate authorization clearing `POST /simulations/cardtransactions/authorization.clearing` ## Request - Base URL: `https://sandbox-api.marqeta.com/v3` - URL: `https://sandbox-api.marqeta.com/v3/simulations/cardtransactions/authorization.clearing` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Clearing is the process of finalizing the hold on funds and posting the transaction on the cardholder's account. This process is triggered by the merchant's capture request. This endpoint simulates an `authorization.clearing` type transaction by including the `preceding_related_transaction_token` and `amount` in your request. ## Request body - AuthorizationClearingEvent - `event_type` string - `card_token` string: Unique identifier of the card. Useful when a single account holder has multiple cards. - `amount` number: Amount of the transaction. - `anticipated_amount` number: Anticipated amount of the transaction, as provided by the card network. - `cash_back_amount` number: The cashback amount requested. - `is_preauthorization` boolean: Indicates if the transaction is a pre-authorization. Set to `true` to mark the amount as an authorization only. - `card_acceptor` TransactionCardAcceptor: Contains information about the merchant. - `mid` string: The merchant identifier. - `mcc` string: Merchant category code (MCC). - `name` string: Card acceptor's name. - `address` string: Card acceptor's address. May be returned if the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests. - `city` string: Card acceptor's city. - `state` string: Two-character state, provincial, territorial, or federal abbreviation. For a complete list of valid abbreviations, see [Valid state, provincial, territorial, and federal abbreviations](/core-api/kyc-verification/perform#_valid_state_provincial_territorial_and_federal_abbreviations). - `postal_code` string: Card acceptor's postal code. - `country_code` string: Card acceptor's country code. May be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests. - `poi` TerminalModel: Contains information about the point of sale, including details about how the card was presented. Returned if provided by the card network, and if the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests. - `tid` string: Card acceptor or terminal identification number. - `partial_approval_capable` string: Indicates whether the card acceptor or terminal supports partial-approval transactions. - `cardholder_presence` string: Indicates whether the cardholder was present during the transaction. - `card_presence` string: Indicates whether the card was present during the transaction. - `channel` string - `processing_type` string - `pin_present` string: Indicates whether the cardholder entered a PIN during the transaction. - `special_condition_indicator` 'UNSPECIFIED' | 'CRYPTOCURRENCY_PURCHASE' | 'QUASI_CASH' | 'DEBT_PAYMENT' | 'CENTRAL_BANK_DIGITAL_CURRENCY_PURCHASE' | 'STABLECOIN_PURCHASE' | 'BLOCKCHAIN_NATIVE_TOKEN_PURCHASE' | 'NON_FUNGIBLE_TOKEN_PURCHASE': Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction. These transactions typically involve non-financial institutions. - `force_post` boolean: Set to `true` to simulate a forced clearing transaction. **NOTE:** If you set this field to `true`, you must also set the `original_transaction_token` field to an existing transaction token (the transaction does not need to be related). - `fees` NetworkFeeModel[]: List of fees associated with the transaction. This array is returned if it exists in the resource. - `type` 'ISSUER_FEE' | 'SWITCH_FEE' | 'PINDEBIT_ASSOC_FEE' | 'ACQUIRER_FEE' | 'INTERCHANGE_FEE' | 'CUR_CONV_CARDHOLDER_FEE' | 'CUR_CONV_ISSUER_FEE' | 'CROSS_BORDER_ISSUER_FEE': The type of fee assessed by the card network. - `amount` number: The amount of the network fee. - `credit_debit` 'C' | 'D': Indicates whether the fee is a credit or a debit. * **C** indicates a credit * **D** indicates a debit The following table lists the default values for fee types: | Fee type | Default value | | --- | --- | | `ISSUER_FEE` | `C` | | `SWITCH_FEE` | `D` | | `PINDEBIT_ASSOC_FEE` | `D` | | `ACQUIRER_FEE` | `D` | | `INTERCHANGE_FEE` | `C` | | `CUR_CONV_CARDHOLDER_FEE` | `D` | | `CUR_CONV_ISSUER_FEE` | `C` | | `CROSS_BORDER_ISSUER_FEE` | `C` | - `card_options` CardOptions: Contains attributes that govern card usage. - `pin` string: The PIN for the card. - `cvv` string: The CVV2 number for the card. - `card_present` boolean: A value of `true` requires that the card be present for the transaction. - `expiration` string: The expiration date of the card. - `billing_address` CardOptionsBillingAddress: Used for Address Verification System (AVS). The address-related fields in this object are verified against known values. - `first_name` string: Cardholder's first name. - `last_name` string: Cardholder's last name. - `address` string: Cardholder's address. - `zip` string: Cardholder's postal code. - `pos` Pos: Contains information about the point of sale, including details on how the card was presented. May be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests. - `partial_approval_capable` boolean: Indicates the capability of the card acceptor or terminal to handle partial approvals. - `special_condition_indicator` 'UNSPECIFIED' | 'CRYPTOCURRENCY_PURCHASE' | 'QUASI_CASH' | 'DEBT_PAYMENT' | 'CENTRAL_BANK_DIGITAL_CURRENCY_PURCHASE' | 'STABLECOIN_PURCHASE' | 'BLOCKCHAIN_NATIVE_TOKEN_PURCHASE' | 'NON_FUNGIBLE_TOKEN_PURCHASE': Indicates special conditions for the transaction. - `pan_entry_mode` 'MAG_STRIPE' | 'MANUAL' | 'MAG_STRIPE_CONTACTLESS' | 'CHIP' | 'CHIP_CONTACTLESS' | 'BAR_CODE' | 'OCR' | 'MICR' | 'CARD_ON_FILE' | 'CHIP_FALLBACK' | 'OTHER': How the card PAN was captured at the point of sale. The Marqeta platform supports different values, depending on which card network was specified using the `network` field. The following table lists the supported PAN capture methods per card network: **NOTE:** This field does not apply to the Discover card network. | Entry mode | Visa | Mastercard | Pulse | | --- | :---: | :---: | :---: | | `CHIP` | ✓ | ✓ | | | `CHIP_CONTACTLESS` | ✓ | ✓ | | | `MAG_STRIPE` | ✓ | ✓ | ✓ | | `MANUAL` | ✓ | ✓ | ✓ | | `CARD_ON_FILE` | ✓ | ✓ | ✓ | | `CHIP_FALLBACK` | ✓ | ✓ | | | `BAR_CODE` | | | ✓ | | `OCR` | | | ✓ | - `preceding_related_transaction_token` string: Unique identifier of the card. Useful when a single account holder has multiple cards. - `network` 'VISA' | 'MASTERCARD' | 'DISCOVER' | 'PULSE': Indicates which card network was used to complete the transaction. - `sub_network` 'VISANET' | 'VISANETDEBIT' | 'VISAINTERLINK' | 'VISAPLUS' | 'MAESTRO' | 'CIRRUS' | 'MASTERCARDDEBIT': Indicates which subnetwork was used to complete the transaction. - `currency_conversion` CurrencyConversion: Contains information from the card network about currency conversion, including the original currency of the transaction, the amount of the transaction in the origination currency, and the conversion rate. Returned if the transaction involves currency conversion. - `original_amount` number: Amount of the transaction in the currency in which it originated. Returned if the transaction involves currency conversion. - `conversion_rate` number, float: Conversion rate between the origination currency and the settlement currency. Returned when the transaction currency is different from the origination currency. - `original_currency_code` string: Currency in which the transaction originated, as an [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html). In a request, the simulator accepts the alpha-3 code, such as `GBP`. In a response or webhook, the card network's numeric code is returned instead, such as `826` for GBP or `840` for USD. - `currency_code` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD': Currency type of the transaction. - `account_funding` AccountFundingRequest: Information used when funding an account. - `first_name` string, required: Account holder's first name. - `last_name` string: Account holder's last name. - `receiver_name` string: Recipient's name. - `funding_source` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'DEPOSIT_ACCOUNT' | 'CASH' | 'MOBILE_MONEY_ACCOUNT' | 'NON_VISA_CREDIT' | 'CHECK' | 'ACH', required: Describes the source of the funding. - `receiver_account_type` 'OTHER' | 'RTN_BANK_ACCOUNT' | 'IBAN' | 'CARD_ACCOUNT' | 'EMAIL' | 'PHONE_NUMBER' | 'BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE' | 'WALLET_ID' | 'SOCIAL_NETWORK_ID', required: Identifies the account type used for the funding request. - `transaction_purpose` string: Identifies the purpose of the transaction. - `transaction_type` 'ACCOUNT_TO_ACCOUNT' | 'PERSON_TO_PERSON' | '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' | 'FUNDS_TRANSFER' | 'VISA_ACCEPT' | 'GENERAL_BUSINESS_TO_BUSINESS_TRANSFER' | 'BUSINESS_TO_BUSINESS_TRANSFER' | 'CASH_DEPOSIT' | 'PURCHASE_REPAYMENT' | 'AFT_OR_OCT_ELIGIBILITY' | 'CONSUMER_BILL_PAYMENT' | 'REQUEST_TO_PAY' | 'LIQUID_ASSET' | 'FAST_REFUND' | 'GAMING_PAYMENT', required: Describes the type of transaction. - `original_credit` OriginalCredit: Contains information about an original credit transaction (OCT), which enables the cardholder to receive funds on the specified card from an external source via the card network. - `funding_source` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'DEPOSIT_ACCOUNT' | 'CASH' | 'MOBILE_MONEY_ACCOUNT' | 'NON_VISA_CREDIT' | 'CHECK' | 'ACH': Describes the source of the funding. - `transaction_type` 'ACCOUNT_TO_ACCOUNT' | 'PERSON_TO_PERSON' | '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' | 'FUNDS_TRANSFER' | 'VISA_ACCEPT' | 'GENERAL_BUSINESS_TO_BUSINESS_TRANSFER' | 'BUSINESS_TO_BUSINESS_TRANSFER' | 'CASH_DEPOSIT' | 'PURCHASE_REPAYMENT' | 'AFT_OR_OCT_ELIGIBILITY' | 'CONSUMER_BILL_PAYMENT' | 'REQUEST_TO_PAY' | 'GAMING_PAYMENT': Describes the type of transaction. - `sender_account_type` 'OTHER' | 'RTN_BANK_ACCOUNT' | 'IBAN' | 'CARD_ACCOUNT' | 'EMAIL' | 'PHONE_NUMBER' | 'BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE' | 'WALLET_ID' | 'SOCIAL_NETWORK_ID': The type of account from which the OCT draws funds. - `sender_name` string: Full name of the sender. - `screening_score` string: Sanctions screening score to assist with meeting Anti-Money Laundering (AML) obligations. Higher scores indicate that the sender's data more closely resembles an entry on the regulatory watchlist. A value of 999 means that no screening score is available. ## Response `201` Created - CardTransactionResponse: Contains information about the simulated transaction. - `transaction` TransactionModel: Contains information about the transaction. - `type` 'gpa.credit' | 'gpa.credit.pending' | 'gpa.credit.pending.reversal' | 'gpa.credit.reversal' | 'gpa.credit.networkload' | 'gpa.credit.networkload.reversal' | 'gpa.debit.networkload' | 'gpa.debit' | 'gpa.debit.pending' | 'gpa.debit.pending.reversal' | 'gpa.grant' | 'gpa.credit.issueroperator' | 'gpa.debit.issueroperator' | 'gpa.credit.chargeback' | 'gpa.credit.chargeback.reversal' | 'gpa.credit.billpayment' | 'gpa.credit.authorization.billpayment' | 'gpa.credit.authorization.billpayment.reversal' | 'authorization' | 'authorization.advice' | 'authorization.reversal' | 'authorization.clearing' | 'authorization.reversal.issuerexpiration' | 'dispute.credit' | 'dispute.debit' | 'authorization.clearing.chargeback' | 'authorization.clearing.chargeback.reversal' | 'refund' | 'pindebit.atm.withdrawal' | 'pindebit.balanceinquiry' | 'pindebit.cashback' | 'pindebit.checkavs' | 'pindebit' | 'programreserve.credit' | 'programreserve.debit' | 'fee.charge.pending' | 'fee.charge' | 'fee.charge.refund' | 'fee.charge.reversal' | 'funds.expire' | 'reward.earn' | 'transfer.peer' | 'transfer.fee' | 'account.funding.authorization' | 'account.funding.authorization.reversal' | 'account.funding.authorization.clearing' | 'account.funding.auth_plus_capture' | 'account.funding.auth_plus_capture.reversal' | 'account.credit' | 'account.debit' | 'balanceinquiry' | 'authorization.atm.withdrawal' | 'authorization.pin.change' | 'authorization.pin.unblock' | 'authorization.clearing.atm.withdrawal' | 'authorization.cashback' | 'authorization.clearing.cashback' | 'transfer.program' | 'authorization.quasi.cash' | 'authorization.clearing.quasi.cash' | 'authorization.incremental' | 'gpa.credit.authorization' | 'gpa.credit.authorization.reversal' | 'gpa.debit.authorization' | 'gpa.debit.reversal' | 'original.credit.authorization' | 'original.credit.authorization.reversal' | 'original.credit.authorization.clearing' | 'original.credit.auth_plus_capture' | 'original.credit.auth_plus_capture.reversal' | 'refund.authorization' | 'refund.authorization.advice' | 'refund.authorization.clearing' | 'refund.authorization.reversal' | 'token.activation-request' | 'token.advice' | 'pindebit.authorization' | 'pindebit.authorization.clearing' | 'pindebit.authorization.reversal' | 'pindebit.authorization.reversal.issuerexpiration' | 'authorization.standin' | 'authorization.clearing.chargeback.completed' | 'authorization.clearing.chargeback.provisional.credit' | 'authorization.clearing.chargeback.provisional.debit' | 'authorization.clearing.chargeback.writeoff' | 'directdeposit.credit' | 'directdeposit.credit.pending' | 'directdeposit.credit.reject' | 'directdeposit.credit.pending.reversal' | 'directdeposit.credit.reversal' | 'directdeposit.debit' | 'directdeposit.debit.pending' | 'directdeposit.debit.reject' | 'directdeposit.debit.reversal' | 'pin.change.reversal' | 'pin.change.reversal.advice' | 'directdeposit.debit.pending.reversal' | 'pindebit.chargeback' | 'pindebit.chargeback.completed' | 'pindebit.chargeback.provisional.credit' | 'pindebit.chargeback.provisional.debit' | 'pindebit.chargeback.reversal' | 'pindebit.chargeback.writeoff' | 'pindebit.pin.change' | 'pindebit.pin.unblock' | 'pindebit.credit.adjustment' | 'pindebit.quasicash' | 'pindebit.quasi.cash' | 'pindebit.refund' | 'pindebit.refund.reversal' | 'pindebit.reversal' | 'pindebit.transfer' | 'pushtocard.debit' | 'pushtocard.reversal' | 'credit.adjustment' | 'debit.adjustment' | 'pin.change.via.api' | 'product.inquiry' | 'transit.offer' | 'transfer.from.checking.hold' | 'transfer.from.checking.clear' | 'transfer.to.checking.open' | 'transfer.to.checking.clear' | 'transfer.to.savings.open' | 'transfer.to.savings.clear' | 'transfer.from.savings.hold' | 'transfer.from.savings.clear' | 'fps.debit.hold' | 'fps.debit.clear' | 'fps.debit.hold.reverse' | 'fps.debit.clear.reverse' | 'fps.credit.open' | 'fps.credit.clear' | 'fps.credit.open.reverse' | 'fps.credit.clear.reverse' | 'interest.posting.clear' | 'interest.posting.clear.reverse' | 'interest.posting.adjustment' | 'unknown', required: Transaction event type. For more information about the `type` field, see [Transaction events](/core-api/event-types#_transaction_events). - `state` 'CLEARED' | 'COMPLETION' | 'DECLINED' | 'ERROR' | 'PENDING', required: Current state of the transaction. For more information about the `state` field, see [The transaction lifecycle](/developer-guides/about-transactions#_the_transaction_lifecycle). - `token` string, required: Unique identifier of the transaction, formatted as a UUID. **NOTE:** For subsequent related transactions, this token value appears as the `preceding_related_transaction_token`. - `user_token` string: Unique identifier of the user who owns the account that funded the transaction. Subsequent related transactions retain the same `user_token`, even if the card used to complete the transaction moves to another user. - `card_token` string: Unique identifier of the card. Useful when a single account holder has multiple cards. - `response` Response: Contains an assertion as to whether the Marqeta platform's address verification data matches data provided by the cardholder. - `code` string, required: Four-digit code corresponding with the outcome of the attempted transaction type. * 0000 – passed * 0001 – did not pass - `memo` string, required: Information on the outcome of the attempted transaction type. - `additional_information` string: Provides information about the relevant velocity control for the transaction, if applicable. - `created_time` string, date-time: Date and time when the Marqeta platform created the transaction entry, in UTC format. For example, when Marqeta processed the clearing record for a refund. - `user_transaction_time` string, date-time: Date and time when the user initiated the transaction, in UTC. For example, when a merchant performed the original authorization for a refund. - `settlement_date` string, date-time: Date and time when funds were moved for a transaction, in UTC. For example, in the case of a refund, when funds were credited to the cardholder. - `amount` number, required: Amount of the transaction. - `amount_to_be_released` number: Amount to released following a financial advice. - `anticipated_amount` number: Anticipated amount of the transaction, as provided by the card network. This field applies to anticipated amount verification transactions (AAVTs). - `cash_back_amount` number: The cashback amount requested. - `request_amount` number: Merchant-requested amount, including any fees. This includes amount and cashback amount. - `gpa` object: Contains information about the GPA balances and pending credits. - `ledger_balance` number: When using standard funding: The funds that are available to spend immediately, including funds from any authorized transactions that have not yet cleared. When using Just-in-Time (JIT) Funding: Authorized funds that are currently on hold, but not yet cleared. - `available_balance` number: Ledger balance minus any authorized transactions that have not yet cleared. Also known as the cardholder's purchasing power. When using JIT Funding, this balance is usually equal to $0.00. - `impacted_amount` number: Balance change based on the amount of the transaction. - `currency_code` string: Currency type of the transaction. - `currency_conversion` CurrencyConversion: Contains information from the card network about currency conversion, including the original currency of the transaction, the amount of the transaction in the origination currency, and the conversion rate. Returned if the transaction involves currency conversion. - `original_amount` number: Amount of the transaction in the currency in which it originated. Returned if the transaction involves currency conversion. - `conversion_rate` number, float: Conversion rate between the origination currency and the settlement currency. Returned when the transaction currency is different from the origination currency. - `original_currency_code` string: Currency in which the transaction originated, as an [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html). In a request, the simulator accepts the alpha-3 code, such as `GBP`. In a response or webhook, the card network's numeric code is returned instead, such as `826` for GBP or `840` for USD. - `preceding_related_transaction_token` string: Returned for final transaction types. Unique identifier of the preceding related transaction. Useful for identifying the transaction that preceded the current one. For example, `authorization`, a temporary transaction type, precedes and is completed by `authorization.clearing`, a final transaction type. In this case, the `authorization` token is returned with this field. See [Transaction events](/core-api/event-types#_transaction_events) for details on which transaction types are temporary or final. - `network` 'VISA' | 'MASTERCARD' | 'PULSE' | 'DISCOVER': Indicates which card network was used to complete the transaction. - `subnetwork` 'VISANET' | 'VISANETDEBIT' | 'VISAINTERLINK' | 'VISAPLUS' | 'MAESTRO' | 'CIRRUS' | 'MASTERCARDDEBIT': Indicates which subnetwork used to complete the transaction. - `acquirer_fee_amount` number: Indicates the amount of the acquirer fee. Account holders are sometimes charged an acquirer fee for card use at places such as ATMs or fuel dispensers. - `fees` NetworkFeeModel[]: List of fees associated with the transaction. This array is returned if it exists in the resource. - `type` 'ISSUER_FEE' | 'SWITCH_FEE' | 'PINDEBIT_ASSOC_FEE' | 'ACQUIRER_FEE' | 'INTERCHANGE_FEE' | 'CUR_CONV_CARDHOLDER_FEE' | 'CUR_CONV_ISSUER_FEE' | 'CROSS_BORDER_ISSUER_FEE': The type of fee assessed by the card network. - `amount` number: The amount of the network fee. - `credit_debit` 'C' | 'D': Indicates whether the fee is a credit or a debit. * **C** indicates a credit * **D** indicates a debit The following table lists the default values for fee types: | Fee type | Default value | | --- | --- | | `ISSUER_FEE` | `C` | | `SWITCH_FEE` | `D` | | `PINDEBIT_ASSOC_FEE` | `D` | | `ACQUIRER_FEE` | `D` | | `INTERCHANGE_FEE` | `C` | | `CUR_CONV_CARDHOLDER_FEE` | `D` | | `CUR_CONV_ISSUER_FEE` | `C` | | `CROSS_BORDER_ISSUER_FEE` | `C` | - `flex` Flex: Contains information about a Flexible Credential transaction. - `action` 'inquiry' | 'advice': Indicates whether the Flexible Credential transaction object is actionable (`inquiry`) or merely informative (`advice`). - `eligible` string: Indicates whether the transaction is eligible for Flexible Credential transactions or not. - `eligible_products` string[]: 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. - `secondary_credential_identifier` string: Identifies the secondary credential used in the transaction, if applicable. - `selected_product` string: Indicates the eligible product that was used in the transaction. - `fraud` FraudView: Contains one or more fraud determinations by the card network that apply either to the transaction or to the cardholder's account. - `network` NetworkFraudView: Contains network-provided information about fraud determinations. - `transaction_risk_score` integer: Network-provided risk score for the transaction. A higher score indicates higher risk. Useful for making authorization decisions. - `transaction_risk_score_reason_code` string: _(Mastercard only)_ Unique code that describes the main driver of the `transaction_risk_score`. - `transaction_risk_score_reason_description` string: _(Mastercard only)_ Description of the `transaction_risk_score_reason_code`. - `account_risk_score` string: _(Visa only)_ Account holder risk condition code evaluated by the card network. A higher score indicates a greater likelihood that the card number is compromised. - `account_risk_score_reason_code` string: _(Visa only)_ Unique code that describes the main driver of the `account_risk_score`. - `card_acceptor` TransactionCardAcceptor: Contains information about the merchant. - `mid` string: The merchant identifier. - `mcc` string: Merchant category code (MCC). - `name` string: Card acceptor's name. - `address` string: Card acceptor's address. May be returned if the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests. - `city` string: Card acceptor's city. - `state` string: Two-character state, provincial, territorial, or federal abbreviation. For a complete list of valid abbreviations, see [Valid state, provincial, territorial, and federal abbreviations](/core-api/kyc-verification/perform#_valid_state_provincial_territorial_and_federal_abbreviations). - `postal_code` string: Card acceptor's postal code. - `country_code` string: Card acceptor's country code. May be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests. - `poi` TerminalModel: Contains information about the point of sale, including details about how the card was presented. Returned if provided by the card network, and if the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests. - `tid` string: Card acceptor or terminal identification number. - `partial_approval_capable` string: Indicates whether the card acceptor or terminal supports partial-approval transactions. - `cardholder_presence` string: Indicates whether the cardholder was present during the transaction. - `card_presence` string: Indicates whether the card was present during the transaction. - `channel` string - `processing_type` string - `pin_present` string: Indicates whether the cardholder entered a PIN during the transaction. - `special_condition_indicator` 'UNSPECIFIED' | 'CRYPTOCURRENCY_PURCHASE' | 'QUASI_CASH' | 'DEBT_PAYMENT' | 'CENTRAL_BANK_DIGITAL_CURRENCY_PURCHASE' | 'STABLECOIN_PURCHASE' | 'BLOCKCHAIN_NATIVE_TOKEN_PURCHASE' | 'NON_FUNGIBLE_TOKEN_PURCHASE': Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction. These transactions typically involve non-financial institutions. - `account_funding` AccountFundingRequest: Information used when funding an account. - `first_name` string, required: Account holder's first name. - `last_name` string: Account holder's last name. - `receiver_name` string: Recipient's name. - `funding_source` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'DEPOSIT_ACCOUNT' | 'CASH' | 'MOBILE_MONEY_ACCOUNT' | 'NON_VISA_CREDIT' | 'CHECK' | 'ACH', required: Describes the source of the funding. - `receiver_account_type` 'OTHER' | 'RTN_BANK_ACCOUNT' | 'IBAN' | 'CARD_ACCOUNT' | 'EMAIL' | 'PHONE_NUMBER' | 'BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE' | 'WALLET_ID' | 'SOCIAL_NETWORK_ID', required: Identifies the account type used for the funding request. - `transaction_purpose` string: Identifies the purpose of the transaction. - `transaction_type` 'ACCOUNT_TO_ACCOUNT' | 'PERSON_TO_PERSON' | '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' | 'FUNDS_TRANSFER' | 'VISA_ACCEPT' | 'GENERAL_BUSINESS_TO_BUSINESS_TRANSFER' | 'BUSINESS_TO_BUSINESS_TRANSFER' | 'CASH_DEPOSIT' | 'PURCHASE_REPAYMENT' | 'AFT_OR_OCT_ELIGIBILITY' | 'CONSUMER_BILL_PAYMENT' | 'REQUEST_TO_PAY' | 'LIQUID_ASSET' | 'FAST_REFUND' | 'GAMING_PAYMENT', required: Describes the type of transaction. - `gpa_order` GpaResponse: Contains information about a GPA order, including fees, funding sources, and addresses. See [GPA Orders](/core-api/gpa-orders) for more information. - `amount` number, required: Amount funded. - `created_time` string, date-time, required: Date and time when the GPA order was created, in UTC. - `currency_code` string, required: The three-digit ISO 4217 currency code. - `fees` FeeDetail[]: List of fees associated with the transaction. This array is returned if it exists in the resource. - `fee` Fee, required: Contains details about the fee. - `active` boolean, required: Indicates whether the fee is active. - `amount` number, required: Amount of the fee. - `created_time` string, date-time, required: Date and time when the `fees` object was created, in UTC. - `currency_code` string, required: The three-digit ISO 4217 currency code. - `last_modified_time` string, date-time, required: Date and time when the GPA order was last modified, in UTC. - `name` string, required: Name of the fee. - `real_time_assessment` RealTimeFeeAssessment: Controls the assessment of real-time fees. - `domestic_enabled` boolean: Enables fee assessments for cases in which the origin of the transaction acquirer is inside the US. - `international_enabled` boolean: Enables fee assessments for cases in which the origin of the transaction acquirer is outside the US. - `transaction_type` string: Indicates the type of transactions for which the fee is assessed. - `tags` string: Descriptive metadata about the fee. - `token` string, required: Unique identifier of the `fees` object. - `memo` string: Additional text that describes the fee transfer. - `tags` string: Descriptive metadata about the fee. - `token` string, required: Unique identifier of the fee. - `transaction_token` string, required: Unique identifier of the fee transaction. - `funding` Funding, required: Contains funding information for the transaction, including funding amount, type, and time of transaction, in UTC. - `amount` number: Amount of funds loaded into the GPA. - `gateway_log` GatewayLogModel: Contains information from the JIT Funding gateway in response to a funding request. - `duration` integer: Length of time taken (in milliseconds) by the gateway to respond to a funding request. - `message` string, required: Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out. - `order_number` string, required: Customer order number, same value as `transaction.token`. - `timed_out` boolean: Whether the gateway sent a response (`true`) or timed out (`false`). - `transaction_id` string, required: Customer-defined identifier for the transaction. - `source` FundingSourceModel, required: Contains funding source information for the transaction, including the funding type and time of transaction, in UTC. - `active` boolean, required: Whether the funding source is active. - `created_time` string, date-time, required: Date and time when the funding source was created, in UTC. - `is_default_account` boolean, required: Indicates whether the GPA order unload's funding source is the default funding account. - `last_modified_time` string, date-time, required: Date and time when the funding source was last modified, in UTC. - `token` string, required: Unique identifier of the funding source. - `type` string, required: Funding type of the funding source. - `source_address` CardholderAddressResponse: Contains information about the billing address of the funding source. - `active` boolean: Whether the address is active. - `address_1` string, required: Street address of the funding source. - `address_2` string: Additional address information for the funding source. This field is returned if it exists in the resource. - `business_token` string: Unique identifier of the business account holder associated with the address. This field is returned if it exists in the resource. It is required if 'user_token' is not specified. - `city` string, required: City of the funding source. - `country` string, required: Country of the funding source. - `created_time` string, date-time, required: Date and time when the address was created, in UTC. - `first_name` string, required: First name of the account holder associated with the funding source. - `is_default_address` boolean: Indicates whether this address is the default address used by the funding source. - `last_modified_time` string, date-time, required: Date and time when the address was last modified, in UTC. This field is returned if it exists in the resource. - `last_name` string, required: Last name of the account holder associated with the funding source. - `phone` string: Phone number of the funding source. This field is returned if it exists in the resource. - `postal_code` string, required: Postal code of the funding source. - `state` string, required: Two-character state, provincial, territorial, or federal abbreviation. For a complete list of valid abbreviations, see [Valid state, provincial, territorial, and federal abbreviations](/core-api/kyc-verification/perform#_valid_state_provincial_territorial_and_federal_abbreviations). - `token` string, required: Unique identifier of the `funding_source_address` object. - `user_token` string: Unique identifier of the user account holder associated with the address. This field is returned if it exists in the resource. It is required if 'business_token' is not specified. - `zip` string, required: United States ZIP code of the funding source. - `funding_source_address_token` string: Unique identifier of the funding source address to use for this order. - `funding_source_token` string, required: Unique identifier of the funding source to use for this order. - `gateway_message` string: Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out. This field is returned if it exists in the resource. - `gateway_token` integer: Unique identifier of the funding source to use for this order. - `jit_funding` JitFundingApi: Contains information about the JIT Funding load event, in which funds are loaded into an account. - `amount` number, required: Requested amount of funding. - `balances` object: Contains the GPA's balance details. - `business_token` string: Holder of the business account that was funded. - `decline_reason` 'INVALID_AMOUNT' | 'INSUFFICIENT_FUNDS' | 'TRANSACTION_NOT_PERMITTED' | 'SUSPECTED_FRAUD' | 'AMOUNT_LIMIT_EXCEEDED' | 'TRANSACTION_COUNT_LIMIT_EXCEEDED' | 'DUPLICATE_TRANSACTION' | 'INVALID_MERCHANT' | 'INVALID_CARD' | 'NO_CREDIT_ACCOUNT' | 'EXPIRED_CARD' | 'NO_CHECKING_ACCOUNT' | 'NO_SAVINGS_ACCOUNT' | 'STOP_PAYMENT' | 'REVOCATION_AUTHORIZATION_ORDER' | 'REVOCATION_ALL_AUTHORIZATION_ORDER' | 'SOFT_DECLINE_AUTHENTICATION_REQUIRED' | 'CLOSED_ACCOUNT' | 'SOFT_DECLINE_PIN_REQUIRED' | 'CARD_NOT_ACTIVE' | 'CARDHOLDER_NOT_ACTIVE': Reason why the transaction was declined. - `incremental_authorization_jit_funding_tokens` string[]: Array of tokens referencing the JIT Funding tokens of all previous associated incremental authorization JIT Funding requests. Useful for ascertaining the final transaction amount when the original amount was incremented. - `memo` string: Additional information that describes the JIT Funding transaction. - `method` 'pgfs.authorization' | 'pgfs.authorization.clearing' | 'pgfs.authorization.advice' | 'pgfs.authorization.incremental' | 'pgfs.authorization.capture' | 'pgfs.authorization.reversal' | 'pgfs.authorization.cashback' | 'pgfs.balanceinquiry' | 'pgfs.auth_plus_capture' | 'pgfs.refund' | 'pgfs.refund.authorization' | 'pgfs.refund.authorization.reversal' | 'pgfs.refund.authorization.clearing' | 'pgfs.force_capture' | 'pgfs.authorization.capture.chargeback' | 'pgfs.authorization.capture.chargeback.reversal' | 'pgfs.pindebit' | 'pgfs.pindebit.chargeback' | 'pgfs.pindebit.chargeback.reversal' | 'pgfs.pindebit.cashback' | 'pgfs.pindebit.refund' | 'pgfs.pindebit.authorization' | 'pgfs.pindebit.authorization.clearing' | 'pgfs.pindebit.authorization.reversal' | 'pgfs.pindebit.atm.withdrawal' | 'pgfs.pindebit.balanceinquiry' | 'pgfs.pindebit.quasi.cash' | 'pgfs.dispute.credit' | 'pgfs.dispute.debit' | 'pgfs.directdeposit.credit' | 'pgfs.directdeposit.debit' | 'pgfs.directdeposit.credit.reversal' | 'pgfs.directdeposit.debit.reversal' | 'pgfs.adjustment.credit' | 'pgfs.adjustment.debit' | 'pgfs.auth_plus_capture.standin' | 'pgfs.authorization.standin' | 'pgfs.network.load' | 'pgfs.original.credit.authorization' | 'pgfs.original.credit.auth_plus_capture' | 'pgfs.original.credit.authorization.clearing' | 'pgfs.original.credit.authorization.reversal' | 'pgfs.billpayment' | 'pgfs.billpayment.capture' | 'pgfs.billpayment.reversal' | 'pgfs.atm.withdrawal' | 'pgfs.atm.clearing.withdrawal' | 'pgfs.authorization.quasi.cash' | 'pgfs.authorization.clearing.quasi.cash' | 'pgfs.authorization.account_verification' | 'pgfs.product.inquiry', required: JIT Funding response type. See [The jit_funding object](/core-api/gateway-jit-funding-messages#_the_jit_funding_object) for the purpose, funding event type, and description of each method. - `original_jit_funding_token` string: Unique identifier of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. - `tags` string: Customer-defined tags related to the JIT Funding transaction. - `token` string, required: Existing JIT Funding token matching the `funding.gateway_log.transaction_id` field of the associated GPA order. Note that the `transaction_id` field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the `transaction_id` field matches the token of the most recent message. - `user_token` string, required: Holder of the user account that was funded. - `last_modified_time` string, date-time, required: Date and time when the `fees` object was last modified, in UTC. - `memo` string: Additional descriptive text. This field is returned if it exists in the resource. - `response` Response, required: Contains an assertion as to whether the Marqeta platform's address verification data matches data provided by the cardholder. - `code` string, required: Four-digit code corresponding with the outcome of the attempted transaction type. * 0000 – passed * 0001 – did not pass - `memo` string, required: Information on the outcome of the attempted transaction type. - `additional_information` string: Provides information about the relevant velocity control for the transaction, if applicable. - `state` string, required: Current status of the funding transaction. - `tags` string: Comma-delimited list of tags describing the order. This field is returned if it exists in the resource. - `token` string, required: Unique identifier of the GPA order. - `transaction_token` string, required: Unique identifier of the transaction being funded. - `user_token` string: Unique identifier of the user resource. This field is returned if it exists in the resource. - `original_credit` OriginalCredit: Contains information about an original credit transaction (OCT), which enables the cardholder to receive funds on the specified card from an external source via the card network. - `funding_source` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'DEPOSIT_ACCOUNT' | 'CASH' | 'MOBILE_MONEY_ACCOUNT' | 'NON_VISA_CREDIT' | 'CHECK' | 'ACH': Describes the source of the funding. - `transaction_type` 'ACCOUNT_TO_ACCOUNT' | 'PERSON_TO_PERSON' | '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' | 'FUNDS_TRANSFER' | 'VISA_ACCEPT' | 'GENERAL_BUSINESS_TO_BUSINESS_TRANSFER' | 'BUSINESS_TO_BUSINESS_TRANSFER' | 'CASH_DEPOSIT' | 'PURCHASE_REPAYMENT' | 'AFT_OR_OCT_ELIGIBILITY' | 'CONSUMER_BILL_PAYMENT' | 'REQUEST_TO_PAY' | 'GAMING_PAYMENT': Describes the type of transaction. - `sender_account_type` 'OTHER' | 'RTN_BANK_ACCOUNT' | 'IBAN' | 'CARD_ACCOUNT' | 'EMAIL' | 'PHONE_NUMBER' | 'BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE' | 'WALLET_ID' | 'SOCIAL_NETWORK_ID': The type of account from which the OCT draws funds. - `sender_name` string: Full name of the sender. - `screening_score` string: Sanctions screening score to assist with meeting Anti-Money Laundering (AML) obligations. Higher scores indicate that the sender's data more closely resembles an entry on the regulatory watchlist. A value of 999 means that no screening score is available. - `account_name_verification` AccountNameVerificationModel: Contains name verification data: the full name entered by the cardholder, name data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. - `on_file` AniInformation: Contains the name of the cardholder for account name verification. - `first_name` string: First name of the cardholder. - `last_name` string: Last name of the cardholder. - `middle_name` string: Middle name of the cardholder. - `request` AniInformation: Contains the name of the cardholder for account name verification. - `first_name` string: First name of the cardholder. - `last_name` string: Last name of the cardholder. - `middle_name` string: Middle name of the cardholder. - `request_type` 'SENDER' | 'RECEIVER': _(Mastercard only)_ Indicates the type of authentication request. - `response` Response: Contains an assertion as to whether the Marqeta platform's address verification data matches data provided by the cardholder. - `code` string, required: Four-digit code corresponding with the outcome of the attempted transaction type. * 0000 – passed * 0001 – did not pass - `memo` string, required: Information on the outcome of the attempted transaction type. - `additional_information` string: Provides information about the relevant velocity control for the transaction, if applicable. - `address_verification` AddressVerificationModel: Contains address verification data: the postal code and street address entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. - `on_file` AvsInformation: Contains the address of the cardholder for account address verification. - `postal_code` string: Postal code of the cardholder. - `street_address` string: Street address of the cardholder. - `request` AvsInformation: Contains the address of the cardholder for account address verification. - `postal_code` string: Postal code of the cardholder. - `street_address` string: Street address of the cardholder. - `response` Response: Contains an assertion as to whether the Marqeta platform's address verification data matches data provided by the cardholder. - `code` string, required: Four-digit code corresponding with the outcome of the attempted transaction type. * 0000 – passed * 0001 – did not pass - `memo` string, required: Information on the outcome of the attempted transaction type. - `additional_information` string: Provides information about the relevant velocity control for the transaction, if applicable. ## Other responses - `404`: Bad Request --- [API](https://skmtc.dev/marqeta/apis/simulations-2-0-api.md) - [All operations](https://skmtc.dev/marqeta/apis/simulations-2-0-api/llms.txt) - [OpenAPI document](https://skmtc.dev/marqeta/apis/simulations-2-0-api/revisions/0d6f0fe4dedb?raw)