> ## Documentation Index > Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Simulate PIN-debit balance inquiry > Use this endpoint to simulate a balance inquiry via the card network. Use this endpoint to simulate a balance inquiry via the card network. This is a non-financial transaction. You can view the full request body structure on the [Simulations 2.0 — Card Transactions](/docs/core-api/simulations-card-transactions) page. ## Request body See the full request body structure at [Request body](/docs/core-api/simulations-card-transactions). ## Sample request body ```json JSON lines wrap theme={null} { "card_token": "**CARD_TOKEN**", "account_type": "savings", "card_acceptor": { "mid": "11111", "partial_approval_capable": "true" }, "network": "VISA" } ``` ## Response body See [Card Transaction Simulation Response](/docs/core-api/simulations-card-transactions). ## Sample response body ```json JSON expandable lines wrap theme={null} { "transaction": { "type": "pindebit.balanceinquiry", "state": "CLEARED", "token": "**PINDEBIT_BALANCEINQUIRY_TRANSACTION_TOKEN**", "user_token": "**USER_TOKEN**", "card_token": "**CARD_TOKEN**", "response": { "code": "0000", "memo": "Approved or completed successfully" }, "created_time": "2025-02-22T18:08:39Z", "user_transaction_time": "2025-02-22T18:08:39Z", "settlement_date": "2025-02-22T00:00:00Z", "amount": 0, "request_amount": 0, "gpa": { "ledger_balance": 250, "available_balance": 250 }, "currency_code": "USD", "currency_conversion": { "original_amount": 0, "conversion_rate": 1, "original_currency_code": "840" }, "network": "VISA", "subnetwork": "VISANETDEBIT", "acquirer_fee_amount": 0, "fraud": { "network": { "transaction_risk_score": 93, "account_risk_score": "1" } }, "card_acceptor": { "mid": "000000000011111", "mcc": "6411", "name": "Marqeta Storefront", "city": "St. Petersburg", "state": "FL", "postal_code": "33705" } } } ``` ## OpenAPI ````yaml POST /simulations/cardtransactions/pindebit.balanceinquiry openapi: 3.0.3 info: title: Simulations 2.0 API description: >- This OpenAPI specification can be used in Postman and for Simulations client generation. contact: name: Marqeta email: support@marqeta.com version: 3.0.0 x-docs-collection: Core API servers: - url: https://sandbox-api.marqeta.com/v3 security: [] tags: - name: Simulations 2.0 — Card Transactions description: >- The Marqeta platform provides you with a production environment and a sandbox. The main difference between the production and sandbox environments is that your production environment communicates with a payment card network. This communication allows your program's cards to pay for goods and services by initiating live transactions over the card network. There are two types of sandbox environments available: * *Public sandbox:* A single-user environment where you can begin building your program and experiment with the Marqeta platform. * *Private sandbox:* A multi-user environment where you can integrate your application with the Marqeta platform. All funds and transactions are simulated in both types of sandbox environments. Unlike the production environment, a sandbox does not communicate with a card network, so the cards you create within them cannot be used to conduct real-world transactions. Therefore, you must rely on simulated transactions in order to test all objects you create within a sandbox. The sandbox environments provide a set of endpoints that let you simulate various types of card network transactions, such as authorizations, reversals, and balance inquiries. These endpoints are available only within the sandbox, so the details on this page do not apply to production. To use the Simulations API for card transactions: * Create a card in your sandbox environment. * Use the `/simulations/cardtransactions/*` endpoints to simulate transaction event types. Each endpoint is its own event type. * Use the `/webhooks` endpoint to send optional customer notifications for system events. To use the Simulations API for direct deposits, see <>. [NOTE] You can use link:https://www.postman.com[Postman, window="_blank"] to run requests for <> and <> simulations endpoints. This collection of requests has been saved as a YAML file for your convenience. To access the YAML file, see <>. All card transaction simulations endpoints share the same request/response model, as described below. - name: Simulations 2.0 — Direct Deposits description: >- The Marqeta platform provides you with a production environment and a sandbox. The main difference between the production and sandbox environments is that your production environment communicates with a payment card network. This communication allows your program's cards to pay for goods and services by initiating live transactions over the card network. There are two types of sandbox environments available: * *Public sandbox:* A single-user environment where you can begin building your program and experiment with the Marqeta platform. * *Private sandbox:* A multi-user environment where you can integrate your application with the Marqeta platform. All funds and transactions are simulated in both types of sandbox environments. Unlike the production environment, a sandbox does not communicate with a card network, so the cards you create within them cannot be used to conduct real-world transactions. Therefore, you must rely on simulated transactions in order to test all objects you create within a sandbox. The sandbox environments provide a set of endpoints that let you simulate various types of card network transactions, such as authorizations, reversals, and balance inquiries. These endpoints are available only within the sandbox, so the details on this page do not apply to production. To use the Simulations API for direct deposits: * Create a card in your sandbox environment. * Use the `/simulations/directdeposits/*` endpoints to simulate transaction event types. Each endpoint is its own event type. * Use the `/webhooks` endpoint to send optional customer notifications for system events. To use the Simulations API for card transactions, see <>. [NOTE] You can use link:https://www.postman.com[Postman, window="_blank"] to run requests for <> and <> simulations endpoints. This collection of requests has been saved as a YAML file for your convenience. To access the YAML file, see <>. All direct deposit simulations endpoints share the same request/response model, as described below. paths: /simulations/cardtransactions/pindebit.balanceinquiry: post: tags: - Simulations 2.0 — Card Transactions summary: Simulate PIN-debit balance inquiry description: >- Use this endpoint to simulate a balance inquiry via the card network. This is a non-financial transaction. You can view the full request body structure on the <> page. operationId: PindebitBalanceInquiryEvent requestBody: content: application/json: schema: $ref: '#/components/schemas/PindebitBalanceinquiryEvent' example: card_token: '**CARD_TOKEN**' account_type: savings card_acceptor: mid: '11111' partial_approval_capable: 'true' network: VISA responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CardTransactionResponse' example: transaction: type: pindebit.balanceinquiry state: CLEARED token: '**PINDEBIT_BALANCEINQUIRY_TRANSACTION_TOKEN**' user_token: '**USER_TOKEN**' card_token: '**CARD_TOKEN**' response: code: '0000' memo: Approved or completed successfully created_time: '2025-02-22T18:08:39.000Z' user_transaction_time: '2025-02-22T18:08:39.000Z' settlement_date: '2025-02-22T00:00:00.000Z' amount: 0 request_amount: 0 gpa: ledger_balance: 250 available_balance: 250 currency_code: USD currency_conversion: original_amount: 0 conversion_rate: 1 original_currency_code: '840' network: VISA subnetwork: VISANETDEBIT acquirer_fee_amount: 0 fraud: network: transaction_risk_score: 93 account_risk_score: '1' card_acceptor: mid: '000000000011111' mcc: '6411' name: Marqeta Storefront city: St. Petersburg state: FL postal_code: '33705' '404': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: PindebitBalanceinquiryEvent: x-tags: - Simulations 2.0 — Card Transactions required: - card_token properties: card_token: $ref: '#/components/schemas/token' card_acceptor: required: - mid properties: mid: type: string description: The merchant identifier. allOf: - $ref: '#/components/schemas/transaction_card_acceptor' CardTransactionResponse: x-tags: - Simulations 2.0 — Card Transactions type: object title: Card Transaction Simulation Response description: Contains information about the simulated transaction. properties: transaction: $ref: '#/components/schemas/TransactionModel' additionalProperties: false Error: type: object title: Error properties: error_code: type: string error_message: type: string token: maxLength: 36 minLength: 0 type: string description: |- Unique identifier of the card. Useful when a single account holder has multiple cards. transaction_card_acceptor: type: object properties: mid: maxLength: 15 minLength: 2 type: string description: The merchant identifier. mcc: maxLength: 5 minLength: 0 type: string description: Merchant category code (MCC). name: maxLength: 255 minLength: 0 type: string description: Card acceptor's name. address: type: string description: >- 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. x-allowableValues: 255 char max city: type: string description: Card acceptor's city. x-allowableValues: 255 char max state: maxLength: 2 type: string description: >- Two-character state, provincial, territorial, or federal abbreviation. For a complete list of valid abbreviations, see <>. postal_code: maxLength: 10 minLength: 0 type: string description: Card acceptor's postal code. country_code: maxLength: 40 type: string description: >- 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: $ref: '#/components/schemas/terminal_model' description: Contains information about the merchant. x-allowableValues: Valid `card_acceptor` object TransactionModel: title: TransactionModel required: - amount - state - token - type type: object properties: type: type: string description: >- Transaction event type. For more information about the `type` field, see <>. readOnly: true enum: - 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 state: type: string description: >- Current state of the transaction. For more information about the `state` field, see <>. enum: - CLEARED - COMPLETION - DECLINED - ERROR - PENDING token: maxLength: 36 minLength: 1 type: string description: >- Unique identifier of the transaction, formatted as a UUID. *NOTE:* For subsequent related transactions, this token value appears as the `preceding_related_transaction_token`. readOnly: true x-faker: datatype.uuid user_token: maxLength: 36 minLength: 0 type: string description: >- 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. x-faker: datatype.uuid card_token: maxLength: 36 minLength: 0 type: string description: |- Unique identifier of the card. Useful when a single account holder has multiple cards. x-faker: datatype.uuid response: $ref: '#/components/schemas/response' created_time: type: string description: >- 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. format: date-time x-allowableValues: |- date-time *Format:* + yyyy-MM-ddThh:mm:ssZ user_transaction_time: type: string description: >- Date and time when the user initiated the transaction, in UTC. For example, when a merchant performed the original authorization for a refund. format: date-time x-allowableValues: |- date-time *Format:* + yyyy-MM-ddThh:mm:ssZ settlement_date: type: string description: >- 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. format: date-time x-allowableValues: |- date-time *Format:* + yyyy-MM-ddThh:mm:ssZ amount: type: number description: Amount of the transaction. x-allowableValues: 'Format: 0.00' x-faker: finance.amount amount_to_be_released: type: number description: Amount to released following a financial advice. x-allowableValues: 'Format: 0.00' anticipated_amount: type: number description: >- Anticipated amount of the transaction, as provided by the card network. This field applies to anticipated amount verification transactions (AAVTs). x-allowableValues: 'Format: 0.00' cash_back_amount: description: The cashback amount requested. type: number x-allowableValues: 'Format: 0.00' request_amount: type: number description: |- Merchant-requested amount, including any fees. This includes amount and cashback amount. x-allowableValues: 'Format: 0.00' gpa: type: object properties: ledger_balance: type: number description: >- 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. x-allowableValues: 'Format: 0.00' x-faker: finance.amount available_balance: type: number description: >- 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. x-allowableValues: 'Format: 0.00' x-faker: finance.amount impacted_amount: type: number description: Balance change based on the amount of the transaction. x-allowableValues: 'Format: 0.00' x-faker: finance.amount description: Contains information about the GPA balances and pending credits. x-allowableValues: |- - `available_balance` - `balances` - `cached_balance` - `credit_balance` - `currency_code` - `impacted_amount` - `last_updated_time` - `ledger_balance` - `pending_credits` currency_code: type: string description: The three-digit ISO 4217 currency code. x-allowableValues: >- Valid three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"] x-faker: finance.currencyCode[] currency_conversion: $ref: '#/components/schemas/currency_conversion' preceding_related_transaction_token: type: string description: >- 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 <> for details on which transaction types are temporary or final. x-faker: datatype.uuid x-allowableValues: 'Format: UUID' network: type: string description: Indicates which card network was used to complete the transaction. enum: - VISA - MASTERCARD - PULSE - DISCOVER subnetwork: type: string description: Indicates which subnetwork used to complete the transaction. enum: - VISANET - VISANETDEBIT - VISAINTERLINK - VISAPLUS - MAESTRO - CIRRUS - MASTERCARDDEBIT acquirer_fee_amount: type: number description: >- 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. x-allowableValues: 'Format: 0.00' fees: type: array description: |- List of fees associated with the transaction. This array is returned if it exists in the resource. items: $ref: '#/components/schemas/network_fee_model' x-allowableValues: Array of existing `fees` objects flex: $ref: '#/components/schemas/flex' fraud: $ref: '#/components/schemas/fraud_view' card_acceptor: $ref: '#/components/schemas/transaction_card_acceptor' account_funding: $ref: '#/components/schemas/account_funding_request' gpa_order: $ref: '#/components/schemas/gpa_response' original_credit: $ref: '#/components/schemas/original_credit' account_name_verification: $ref: '#/components/schemas/account_name_verification_model' address_verification: $ref: '#/components/schemas/address_verification_model' description: Contains information about the transaction. x-allowableValues: Existing `transaction` object terminal_model: type: object properties: tid: type: string description: Card acceptor or terminal identification number. x-allowableValues: 255 char max partial_approval_capable: type: string description: >- Indicates whether the card acceptor or terminal supports partial-approval transactions. x-allowableValues: 255 char max cardholder_presence: type: string description: Indicates whether the cardholder was present during the transaction. x-allowableValues: 255 char max card_presence: type: string description: Indicates whether the card was present during the transaction. x-allowableValues: 255 char max channel: type: string x-mq-internal: true processing_type: type: string x-mq-internal: true pin_present: type: string description: >- Indicates whether the cardholder entered a PIN during the transaction. x-allowableValues: 255 char max special_condition_indicator: type: string 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 description: >- 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. x-allowableValues: >- `tid`, `partial_approval_capable`, `cardholder_presence`, `card_presence`, `pin_present`, `special_condition_indicator` response: type: object description: >- Contains an assertion as to whether the Marqeta platform's address verification data matches data provided by the cardholder. x-allowableValues: Existing `response` object required: - code - memo properties: code: type: string description: >- Four-digit code corresponding with the outcome of the attempted transaction type. * 0000 – passed * 0001 – did not pass x-allowableValues: Four-digit code memo: type: string description: Information on the outcome of the attempted transaction type. x-allowableValues: 255 char max additional_information: type: string description: >- Provides information about the relevant velocity control for the transaction, if applicable. x-allowableValues: >- The `additional_information` field returns a string in the following format: `, cumulative transaction amount is `, where `X` is the cumulative transaction amount value calculated by Marqeta. For example: `500 max spend per day, cumulative transaction amount is 750`. currency_conversion: type: object properties: original_amount: type: number description: |- Amount of the transaction in the currency in which it originated. Returned if the transaction involves currency conversion. x-allowableValues: 'Format: 0.00' conversion_rate: type: number description: >- Conversion rate between the origination currency and the settlement currency. Returned when the transaction currency is different from the origination currency. format: float x-allowableValues: >- Current conversion rate *NOTE:* A value of `0` or `1` indicates no conversion; the currencies are the same. original_currency_code: type: string description: The three-digit ISO 4217 currency code. x-allowableValues: >- Valid three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"] description: >- 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. x-allowableValues: Valid `currency_conversion` object network_fee_model: type: object properties: type: type: string description: The type of fee assessed by the card network. enum: - ISSUER_FEE - SWITCH_FEE - PINDEBIT_ASSOC_FEE - ACQUIRER_FEE - INTERCHANGE_FEE - CUR_CONV_CARDHOLDER_FEE - CUR_CONV_ISSUER_FEE - CROSS_BORDER_ISSUER_FEE amount: type: number description: The amount of the network fee. x-allowableValues: 'Format: 0.00' credit_debit: type: string description: |- 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: [cols="2a,1"] !=== ! 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` !=== enum: - C - D description: Contains card network fees assessed against the cardholder. x-allowableValues: Valid `fees` 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 the transaction is eligible for Flexible Credential transactions or not. type: string x-allowableValues: '`true`, `false`' 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 x-allowableValues: '`DEBIT`, `LOAN`, `DEBIT_TO_LOAN`' secondary_credential_identifier: description: >- Identifies the secondary credential used in the transaction, if applicable. type: string x-allowableValues: 255 char max selected_product: description: Indicates the eligible product that was used in the transaction. type: string x-allowableValues: '`DEBIT`, `LOAN`' type: object x-allowableValues: >- `action`, `eligible`, `eligible_products`, `secondary_credential_identifier`, `selected_product` fraud_view: type: object properties: network: $ref: '#/components/schemas/network_fraud_view' description: >- Contains one or more fraud determinations by the card network that apply either to the transaction or to the cardholder's account. x-allowableValues: >- `issuer_processor`, `network_fraud_view`, `network_account_intelligence_score` account_funding_request: required: - first_name - funding_source - receiver_account_type - transaction_type type: object properties: first_name: type: string description: Account holder's first name. x-allowableValues: To pass AVS, must match the first name on record. last_name: type: string description: Account holder's last name. x-allowableValues: To pass AVS, must match the last name on record. receiver_name: type: string description: Recipient's name. x-allowableValues: To pass AVS, must match the name on record. funding_source: type: string description: Describes the source of the funding. enum: - CREDIT - DEBIT - PREPAID - DEPOSIT_ACCOUNT - CASH - MOBILE_MONEY_ACCOUNT - NON_VISA_CREDIT - CHECK - ACH receiver_account_type: type: string description: Identifies the account type used for the funding request. enum: - OTHER - RTN_BANK_ACCOUNT - IBAN - CARD_ACCOUNT - EMAIL - PHONE_NUMBER - BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE - WALLET_ID - SOCIAL_NETWORK_ID transaction_purpose: type: string description: Identifies the purpose of the transaction. x-allowableValues: |- - `FAMILY_SUPPORT` - `REGULAR_LABOR_TRANSFERS` - `TRAVEL_AND_TOURISM` - `EDUCATION` - `MEDICAL_TREATMENT` - `EMERGENCY_NEED` - `SAVINGS` - `GIFTS` - `OTHER` - `SALARY` - `CROWD_LENDING` - `CRYPTO_CURRENCY` transaction_type: type: string description: Describes the type of transaction. enum: - 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 description: Information used when funding an account. x-allowableValues: Valid `account_funding` object gpa_response: required: - amount - created_time - currency_code - funding - funding_source_token - last_modified_time - response - state - token - transaction_token type: object properties: amount: type: number description: Amount funded. x-allowableValues: 'Format: 0.00' created_time: type: string description: Date and time when the GPA order was created, in UTC. format: date-time x-allowableValues: |- date-time *Format:* + yyyy-MM-ddThh:mm:ssZ currency_code: type: string description: The three-digit ISO 4217 currency code. x-allowableValues: >- Valid three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"] fees: type: array description: |- List of fees associated with the transaction. This array is returned if it exists in the resource. xml: name: fees wrapped: true items: $ref: '#/components/schemas/fee_detail' x-allowableValues: Array of existing `fees` objects funding: $ref: '#/components/schemas/funding' funding_source_address_token: type: string description: >- Unique identifier of the funding source address to use for this order. x-allowableValues: Existing `funding_source_address` token funding_source_token: type: string description: Unique identifier of the funding source to use for this order. x-allowableValues: Existing `funding_source_address` token gateway_message: type: string description: >- 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. x-allowableValues: >- `Approved or completed successfully`, `Declined by gateway`,`Operation timeout` gateway_token: type: integer description: Unique identifier of the funding source to use for this order. format: int64 x-allowableValues: Existing `gateway_token` jit_funding: $ref: '#/components/schemas/jit_funding_api' last_modified_time: type: string description: Date and time when the `fees` object was last modified, in UTC. format: date-time x-allowableValues: |- date-time *Format:* + yyyy-MM-ddThh:mm:ssZ memo: type: string description: |- Additional descriptive text. This field is returned if it exists in the resource. x-allowableValues: 99 char max response: $ref: '#/components/schemas/response' state: type: string description: Current status of the funding transaction. x-allowableValues: '`PENDING`, `CLEARED`, `COMPLETION`, `DECLINED`, `ERROR`,`ALL`' tags: type: string description: |- Comma-delimited list of tags describing the order. This field is returned if it exists in the resource. x-allowableValues: 255 char max token: type: string description: Unique identifier of the GPA order. x-allowableValues: 36 char max transaction_token: type: string description: Unique identifier of the transaction being funded. x-allowableValues: 'Format: UUID' user_token: type: string description: |- Unique identifier of the user resource. This field is returned if it exists in the resource. x-allowableValues: Existing user resource token description: >- Contains information about a GPA order, including fees, funding sources, and addresses. See <> for more information. xml: name: gpa_response x-allowableValues: Existing `gpa_order` object original_credit: type: object properties: funding_source: type: string description: Describes the source of the funding. enum: - CREDIT - DEBIT - PREPAID - DEPOSIT_ACCOUNT - CASH - MOBILE_MONEY_ACCOUNT - NON_VISA_CREDIT - CHECK - ACH transaction_type: type: string description: Describes the type of transaction. enum: - 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 sender_account_type: type: string description: The type of account from which the OCT draws funds. enum: - OTHER - RTN_BANK_ACCOUNT - IBAN - CARD_ACCOUNT - EMAIL - PHONE_NUMBER - BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE - WALLET_ID - SOCIAL_NETWORK_ID sender_name: type: string description: Full name of the sender. x-allowableValues: 255 char max screening_score: type: string description: >- 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. x-allowableValues: 000-100, 999 description: >- 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. x-allowableValues: Existing `original_credit` object account_name_verification_model: properties: on_file: $ref: '#/components/schemas/ani_information' request: $ref: '#/components/schemas/ani_information' request_type: enum: - SENDER - RECEIVER type: string description: _(Mastercard only)_ Indicates the type of authentication request. response: $ref: '#/components/schemas/response' type: object description: >- 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. x-allowableValues: '`on_file`, `request`, `request_type`, `response`' address_verification_model: properties: on_file: $ref: '#/components/schemas/avs_information' request: $ref: '#/components/schemas/avs_information' response: $ref: '#/components/schemas/response' type: object description: >- 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. x-allowableValues: '`on_file`, `request`, `response`' network_fraud_view: type: object properties: transaction_risk_score: type: integer description: |- Network-provided risk score for the transaction. A higher score indicates higher risk. Useful for making authorization decisions. format: int32 x-allowableValues: |- Mastercard: 0-999 Visa: 0-99 transaction_risk_score_reason_code: type: string description: >- _(Mastercard only)_ Unique code that describes the main driver of the `transaction_risk_score`. x-allowableValues: 1-29 transaction_risk_score_reason_description: type: string description: >- _(Mastercard only)_ Description of the `transaction_risk_score_reason_code`. x-allowableValues: 255 char max account_risk_score: type: string description: >- _(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. x-allowableValues: 1-9 account_risk_score_reason_code: type: string description: >- _(Visa only)_ Unique code that describes the main driver of the `account_risk_score`. x-allowableValues: 255 char max description: Contains network-provided information about fraud determinations. x-allowableValues: |- - `account_risk_score` - `account_risk_score_reason_code` - `transaction_risk_score` - `transaction_risk_score_reason_code` - `transaction_risk_score_reason_description` x-tags: - Simulations 2.0 — Card Transactions fee_detail: required: - fee - token - transaction_token type: object properties: fee: $ref: '#/components/schemas/fee' memo: maxLength: 99 minLength: 1 type: string description: Additional text that describes the fee transfer. tags: maxLength: 255 minLength: 0 type: string description: Descriptive metadata about the fee. token: maxLength: 36 minLength: 1 type: string description: Unique identifier of the fee. transaction_token: type: string description: Unique identifier of the fee transaction. x-allowableValues: 36 char max funding: required: - source type: object properties: amount: type: number description: Amount of funds loaded into the GPA. x-allowableValues: 'Format: 0.00' gateway_log: $ref: '#/components/schemas/gateway_log_model' source: $ref: '#/components/schemas/funding_source_model' source_address: $ref: '#/components/schemas/CardholderAddressResponse' description: >- Contains funding information for the transaction, including funding amount, type, and time of transaction, in UTC. xml: name: funding x-allowableValues: '`amount`, `gateway_log`, `source`, `source_address`' jit_funding_api: required: - amount - method - token - user_token type: object properties: amount: minimum: 0 exclusiveMinimum: false type: number description: Requested amount of funding. balances: type: object additionalProperties: $ref: '#/components/schemas/cardholder_balance' description: Contains the GPA's balance details. x-allowableValues: Existing `balances` object business_token: maxLength: 36 minLength: 0 type: string description: Holder of the business account that was funded. decline_reason: type: string description: Reason why the transaction was declined. enum: - 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 incremental_authorization_jit_funding_tokens: type: array description: >- 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. items: type: string x-allowableValues: Existing incremental authorization JIT Funding tokens memo: maxLength: 99 minLength: 0 type: string description: Additional information that describes the JIT Funding transaction. method: type: string description: >- JIT Funding response type. See <> for the purpose, funding event type, and description of each method. enum: - 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 original_jit_funding_token: maxLength: 36 minLength: 0 type: string description: >- 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: maxLength: 255 minLength: 0 type: string description: Customer-defined tags related to the JIT Funding transaction. token: maxLength: 36 minLength: 0 type: string description: >- 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: maxLength: 36 minLength: 0 type: string description: Holder of the user account that was funded. description: >- Contains information about the JIT Funding load event, in which funds are loaded into an account. x-allowableValues: |- - `acting_user_token` - `address_verification` - `amount` - `balances` - `business_token` - `decline_reason` - `incremental_authorization_jit_funding_tokens` - `memo` - `method` - `original_jit_funding_token` - `tags` - `token` - `user_token` ani_information: properties: first_name: description: First name of the cardholder. type: string x-allowableValues: 40 char max last_name: description: Last name of the cardholder. type: string x-allowableValues: 40 char max middle_name: description: Middle name of the cardholder. type: string x-allowableValues: 40 char max description: Contains the name of the cardholder for account name verification. type: object x-allowableValues: '`first_name`, `last_name`, `middle_name`' avs_information: properties: postal_code: description: Postal code of the cardholder. type: string x-allowableValues: 10 char max street_address: description: Street address of the cardholder. type: string x-allowableValues: 255 char max type: object description: Contains the address of the cardholder for account address verification. x-allowableValues: '`postal_code`, `street_address`' fee: required: - active - amount - created_time - currency_code - last_modified_time - name - token type: object properties: active: type: boolean description: Indicates whether the fee is active. default: false x-allowableValues: '`true`, `false`' amount: type: number description: Amount of the fee. x-allowableValues: 'Format: 0.00' created_time: type: string description: Date and time when the `fees` object was created, in UTC. format: date-time x-allowableValues: 'Format: yyyy-MM-ddTHH:mm:ssZ' currency_code: type: string description: The three-digit ISO 4217 currency code. x-allowableValues: >- Valid three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"] last_modified_time: type: string description: Date and time when the GPA order was last modified, in UTC. format: date-time x-allowableValues: 'Format: yyyy-MM-ddTHH:mm:ssZ' name: type: string description: Name of the fee. x-allowableValues: 50 char max real_time_assessment: $ref: '#/components/schemas/real_time_fee_assessment' tags: type: string description: Descriptive metadata about the fee. x-allowableValues: 255 char max token: type: string description: Unique identifier of the `fees` object. x-allowableValues: Existing `fees` object token description: Contains details about the fee. x-allowableValues: >- `active`, `amount`, `created_time`, `currency_code`, `last_modified_time`, `name`, `real_time_assessment`, `tags`, `token` gateway_log_model: required: - message - order_number - transaction_id type: object properties: duration: type: integer description: >- Length of time taken (in milliseconds) by the gateway to respond to a funding request. format: int64 x-allowableValues: Any integer message: type: string description: >- 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. x-allowableValues: >- `Approved or completed successfully`, `Declined by gateway`, `Operation timeout` order_number: type: string description: Customer order number, same value as `transaction.token`. x-allowableValues: Existing `transaction.token` value timed_out: type: boolean description: Whether the gateway sent a response (`true`) or timed out (`false`). default: false x-allowableValues: '`true`, `false`' transaction_id: type: string description: Customer-defined identifier for the transaction. x-allowableValues: 255 char max description: >- Contains information from the JIT Funding gateway in response to a funding request. xml: name: gateway_log_model x-allowableValues: >- `duration`, `message`, `order_number`, `response`, `timed_out`, `transaction_id` funding_source_model: required: - active - created_time - is_default_account - last_modified_time - token - type type: object properties: active: type: boolean description: Whether the funding source is active. default: false x-allowableValues: '`true`, `false`' created_time: type: string description: Date and time when the funding source was created, in UTC. format: date-time x-allowableValues: 'Format: yyyy-MM-ddTHH:mm:ssZ' is_default_account: type: boolean description: >- Indicates whether the GPA order unload's funding source is the default funding account. default: false x-allowableValues: '`true`, `false`' last_modified_time: type: string description: Date and time when the funding source was last modified, in UTC. format: date-time x-allowableValues: 'Format: yyyy-MM-ddTHH:mm:ssZ' token: type: string description: Unique identifier of the funding source. x-allowableValues: 'Format: UUID' type: type: string description: Funding type of the funding source. x-allowableValues: '`ach`, `paymentcard`' description: >- Contains funding source information for the transaction, including the funding type and time of transaction, in UTC. x-allowableValues: >- `active`, `created_time`, `is_default_account`, `last_modified_time`, `token`, `type` CardholderAddressResponse: required: - address_1 - city - country - created_time - first_name - last_modified_time - last_name - postal_code - state - token - zip type: object properties: active: type: boolean description: Whether the address is active. default: false x-allowableValues: '`true`, `false`' address_1: maxLength: 255 minLength: 0 type: string description: Street address of the funding source. address_2: maxLength: 255 minLength: 0 type: string description: |- Additional address information for the funding source. This field is returned if it exists in the resource. business_token: maxLength: 36 minLength: 1 type: string description: >- 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: maxLength: 40 minLength: 0 type: string description: City of the funding source. country: maxLength: 40 minLength: 1 type: string description: Country of the funding source. created_time: type: string description: Date and time when the address was created, in UTC. format: date-time x-allowableValues: 'Format: yyyy-MM-ddTHH:mm:ssZ' first_name: maxLength: 40 minLength: 0 type: string description: First name of the account holder associated with the funding source. is_default_address: type: boolean description: >- Indicates whether this address is the default address used by the funding source. default: false x-allowableValues: '`true`, `false`' last_modified_time: type: string description: |- Date and time when the address was last modified, in UTC. This field is returned if it exists in the resource. format: date-time x-allowableValues: 'Format: yyyy-MM-ddTHH:mm:ssZ' last_name: maxLength: 40 minLength: 0 type: string description: Last name of the account holder associated with the funding source. phone: maxLength: 255 minLength: 0 type: string description: |- Phone number of the funding source. This field is returned if it exists in the resource. postal_code: maxLength: 10 minLength: 0 type: string description: Postal code of the funding source. state: maxLength: 2 minLength: 0 type: string description: >- Two-character state, provincial, territorial, or federal abbreviation. For a complete list of valid abbreviations, see <>. token: maxLength: 36 minLength: 1 type: string description: Unique identifier of the `funding_source_address` object. user_token: maxLength: 36 minLength: 1 type: string description: >- 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: maxLength: 10 minLength: 0 type: string description: United States ZIP code of the funding source. description: Contains information about the billing address of the funding source. x-allowableValues: |- - `active` - `address_1` - `address_2` - `business_token` - `city` - `country` - `created_time` - `first_name` - `is_default_address` - `last_modified_time` - `last_name` - `phone` - `postal_code` - `state` - `token` - `user_token` - `zip` cardholder_balance: required: - available_balance - balances - cached_balance - credit_balance - currency_code - last_updated_time - ledger_balance - pending_credits type: object properties: available_balance: type: number balances: type: object additionalProperties: $ref: '#/components/schemas/cardholder_balance' cached_balance: type: number credit_balance: type: number currency_code: type: string impacted_amount: type: number last_updated_time: type: string format: date-time ledger_balance: type: number pending_credits: type: number x-tags: - Simulations 2.0 — Card Transactions real_time_fee_assessment: type: object properties: domestic_enabled: type: boolean description: >- Enables fee assessments for cases in which the origin of the transaction acquirer is inside the US. default: false x-allowableValues: '`true`, `false`' international_enabled: type: boolean description: >- Enables fee assessments for cases in which the origin of the transaction acquirer is outside the US. default: false x-allowableValues: '`true`, `false`' transaction_type: type: string description: Indicates the type of transactions for which the fee is assessed. x-allowableValues: '`authorization`, `pindebit.atm.withdrawal`, `pindebit`' description: Controls the assessment of real-time fees. x-allowableValues: '`domestic_enabled`, `international_enabled`, `transaction_type`' ```` ## Related topics - [PIN-Debit Simulations Overview](/docs/core-api/simulations-card-transactions/pin-debit.md) - [Simulations 2.0 — Card Transactions Overview](/docs/core-api/simulations-card-transactions.md) - [Simulate balance inquiry](/docs/core-api/simulating-transactions/simulate-balance-inquiry.md) - [Simulate PIN-debit](/docs/core-api/simulations-card-transactions/pin-debit/simulate-pin-debit.md) - [Simulate PIN-debit authorization](/docs/core-api/simulations-card-transactions/pin-debit/simulate-pin-debit-authorization.md)