openapi: 3.0.3 info: contact: email: support@marqeta.com name: Marqeta description: Marqeta's Core API endpoints, conveniently annotated to enable code generation (including SDKs), test cases, and documentation. Currently in beta. termsOfService: https://www.marqeta.com/api-terms title: Core accepted countries simulate API version: 3.0.39 servers: - url: /v3 security: - mqAppAndAccessToken: [] tags: - name: simulate paths: /simulate/authorization: post: operationId: postSimulateAuthorization requestBody: content: application/json: schema: $ref: '#/components/schemas/auth_request_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: {} description: User input error/Bad request '500': content: {} description: Server error summary: Simulates an authorization tags: - simulate /simulate/authorization/advice: post: operationId: postSimulateAuthorizationAdvice requestBody: content: application/json: schema: $ref: '#/components/schemas/authorization_advice_model' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Original transaction not found '500': content: {} description: Server error summary: Simulates an authorization advice transaction tags: - simulate /simulate/clearing: post: operationId: postSimulateClearing requestBody: content: application/json: schema: $ref: '#/components/schemas/ClearingModel' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Original transaction not found '500': content: {} description: Server error summary: Simulates a clearing/settlement transaction tags: - simulate /simulate/directdeposits: post: operationId: postSimulateDirectdeposits requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectDepositRequest' description: Direct deposit simulate request model required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DepositDepositResponse' description: Success '400': content: {} description: Bad request '500': content: {} description: Server error summary: Simulates the creation of direct deposit tags: - simulate /simulate/financial: post: operationId: postSimulateFinancial requestBody: content: application/json: schema: $ref: '#/components/schemas/financial_request_model' description: Financial request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: {} description: User input error/Bad request '500': content: {} description: Server error summary: Simulates a financial request (PIN debit) transaction with optional cash back tags: - simulate /simulate/financial/advice: post: operationId: postSimulateFinancialAdvice requestBody: content: application/json: schema: $ref: '#/components/schemas/authorization_advice_model' description: Financial advice request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Original transaction not found '500': content: {} description: Server error summary: Simulates a financial advice transaction tags: - simulate /simulate/financial/balanceinquiry: post: operationId: postSimulateFinancialBalanceinquiry requestBody: content: application/json: schema: $ref: '#/components/schemas/balance_inquiry_request_model' description: Balance inquiry request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: {} description: User input error/Bad request '500': content: {} description: Server error summary: Simulates a balance inquiry tags: - simulate /simulate/financial/originalcredit: post: operationId: postSimulateFinancialOriginalcredit requestBody: content: application/json: schema: $ref: '#/components/schemas/orignalcredit_request_model' description: Orignal Credit request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: {} description: User input error/Bad request '500': content: {} description: Server error summary: Simulates an orignal credit transaction tags: - simulate /simulate/financial/withdrawal: post: operationId: postSimulateFinancialWithdrawal requestBody: content: application/json: schema: $ref: '#/components/schemas/withdrawal_request_model' description: ATM withdrawal request model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: {} description: User input error/Bad request '500': content: {} description: Server error summary: Simulates an ATM withdrawal transaction tags: - simulate /simulate/reversal: post: operationId: postSimulateReversal requestBody: content: application/json: schema: $ref: '#/components/schemas/ReversalModel' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/simulation_response_model' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Original transaction not found '500': content: {} description: Server error summary: Simulates a reversal transaction tags: - simulate components: schemas: transaction_metadata: description: 'Contains merchant-provided metadata related to the transaction, including details about lodging- and transit-related purchases. May be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests.' properties: airline: $ref: '#/components/schemas/airline' authorization_life_cycle: description: Number of days the pre-authorization is in effect. format: int32 type: integer cross_border_transaction: default: false description: Whether the transaction is cross-border, i.e., when the merchant and the cardholder are located in two different countries. type: boolean is_deferred_authorization: description: Indicates an offline authorization made during an interruption of card network connectivity, such as a purchase on a flight. type: boolean is_lodging_auto_rental: default: false description: Whether the transaction is a lodging or vehicle rental. type: boolean lodging_auto_rental_start_date: description: Date and time when the lodging check-in or vehicle rental began. format: date-time type: string memo: description: Indicates a credit or debit adjustment in a clearing transaction. enum: - CREDIT_ADJUSTMENT - DEBIT_ADJUSTMENT maxLength: 99 minLength: 1 type: string moto_indicator: description: Indicates the type of mail or telephone order transaction. enum: - UNKNOWN - MANUAL - RECURRING - INSTALLMENT - OTHERS type: string one_leg_out: type: boolean payment_channel: description: Channel from which the transaction was originated. enum: - OTHER - ATM - ECOMMERCE - MAIL - PHONE - MOTO type: string special_purchase_id: type: string transaction_category: description: Type of product or service being purchased, if provided by the merchant. enum: - RETAIL_SALE - BILL_PAY - HOTEL - HEALTH_CARE - RESTAURANT - AUTO_RENTAL - AIRLINE - PAYMENT - HOSPITALIZATION_COLLEGE - PHONE_MAIL_ECOMMERCE - ATM - TRANSIT - EXTENDED_AUTHORIZATION type: string transit: $ref: '#/components/schemas/transit' type: object cardholder_verification: properties: result: description: Biometric verification result enum: - Pass - Fail - not present type: string verification_method: description: Cardholder verification method enum: - Biometric type: string type: object transaction_card_acceptor: description: Contains information about the merchant. properties: address: 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.' type: string business_registration_id: description: Business registration identifier, as provided by the Visa card network. type: string business_registration_id_type: description: Business registration identifier type, as provided by the Visa card network. enum: - unspecified - tax_registration_identification - national_identification - company_registration_identification - passport - default_value type: string city: description: Card acceptor's city. type: string country_code: 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.' type: string country_of_origin: description: 'The merchant''s country of origin. A merchant''s country of origin can be different from the country in which the merchant is located. For example, embassies are physically located in countries that are not their country of origin: a Mexican embassy might be physically located in Singapore, but the country of origin is Mexico. This field is included when the cardholder conducts a transaction with a government-controlled merchant using a Marqeta-issued card.' type: string customer_service_phone: type: string geographic_coordinates: description: 'For Mastercard only. Geographic coordinates of the card acceptor in `latitudeE7,longitudeE7` format.' type: string independent_sales_organization_id: type: string legal_business_name: description: Legal business name, as provided by the Visa card network. type: string mcc: description: Merchant category code (MCC). type: string mcc_groups: description: An array of `mcc_groups`. items: type: string type: array merchant_tax_id: type: string merchant_vat_registration_id: description: The VAT registration identifier of the merchant. type: string mid: description: The merchant identifier. type: string name: description: Card acceptor's name. type: string network_assigned_id: description: Identifier assigned by the card network. type: string network_mid: description: The merchant identifier on the card network. type: string payment_facilitator_id: type: string payment_facilitator_name: description: 'The name of the payment facilitator, including the sub-merchant identifier, of an original credit transaction. This field is returned when a payment facilitator participates in the transaction.' type: string phone: type: string poi: $ref: '#/components/schemas/terminal_model' postal_code: description: Card acceptor's postal code. type: string service_geographic_coordinates: description: 'For Mastercard only. Geographic coordinates of the service provider in `latitudeE7,longitudeE7` format.' type: string special_merchant_id: type: string state: description: 'State, provincial, territorial, or federal abbreviation (`CA` for California or `CAN` for Canada, for example). For the complete list, see <>. *Note*: Non-US merchants may return more than 2 char for this field.' type: string sub_merchant_id: type: string transfer_service_provider_name: description: 'The name of the transfer service provider of a money transfer original credit transaction. This field is included when a transfer service provider participates in the transaction.' type: string url: type: string type: object CardFulfillmentResponse: description: Determines physical characteristics of a card and shipment information. properties: card_fulfillment_reason: description: Descriptive reason for the card fulfillment. enum: - NEW - LOST_STOLEN - EXPIRED type: string card_personalization: $ref: '#/components/schemas/card_personalization' shipping: $ref: '#/components/schemas/ShippingInformationResponse' required: - card_personalization type: object account_owner_model: description: Information about the owner of an account participating in an account funding or original credit transaction. properties: country_of_birth: description: Account owner's country of birth. type: string dob: description: Account owner's date of birth. type: string email_address: description: Account owner's email address. type: string nationality: description: Account owner's nationality. type: string occupation: description: Account owner's occupation. type: string type: object fleet_data: description: Contains details about fleet program transactions. properties: prompt_data: description: If card product is configured for prompting, contains prompt data entered at the point of sale. properties: driver_number: description: Driver number entered at the point of sale. type: string odometer: description: Fleet vehicle odometer reading entered at the point of sale. type: string vehicle_number: description: Vehicle number entered at the point of sale. type: string type: object purchase_type: description: If provided by the network, indicates whether the purchase contains items for fuel, non-fuel, or both. enum: - fuel - non-fuel - fuel_and_non_fuel type: string type: object gpa_response: description: 'Contains information about a GPA order, including fees, funding sources, and addresses. See <> for more information.' properties: amount: description: Amount funded. type: number business_token: description: 'Unique identifier of the business. This field is returned if it exists in the resource.' type: string created_time: description: Date and time when the GPA order was created, in UTC. format: date-time type: string currency_code: description: Three-digit ISO 4217 currency code. type: string fees: description: 'List of fees associated with the funding transaction. This array is returned if it exists in the resource.' items: $ref: '#/components/schemas/fee_detail' type: array funding: $ref: '#/components/schemas/funding' funding_source_address_token: description: Unique identifier of the funding source address to use for this order. type: string funding_source_token: description: Unique identifier of the funding source to use for this order. type: string gateway_message: 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.' type: string gateway_token: description: 'Unique identifier of the JIT Funding request and response. This field is returned if it exists in the resource.' format: int64 type: integer jit_funding: $ref: '#/components/schemas/jit_funding_api' last_modified_time: description: Date and time when the GPA order was last modified, in UTC. format: date-time type: string memo: description: 'Additional descriptive text. This field is returned if it exists in the resource.' type: string response: $ref: '#/components/schemas/response' state: description: Current status of the funding transaction. type: string tags: description: 'Comma-delimited list of tags describing the GPA order. This field is returned if it exists in the resource.' type: string token: description: Unique identifier of the GPA order. type: string transaction_token: description: Unique identifier of the transaction being funded. type: string user_token: description: 'Unique identifier of the user resource. This field is returned if it exists in the resource.' type: string required: - amount - created_time - currency_code - funding - funding_source_token - last_modified_time - response - state - token - transaction_token type: object transaction_device: description: 'Contains information about the device used in the transaction to enhance the risk decisioning process. Use this data to improve fraud prevention and dispute resolution.' properties: binding_id: description: Unique identifier of the data component bound to the credential. type: string ip_address: description: 'IP address of the device. The presence of the IP address helps determine if the transaction was initiated from an unusual network, helping establish a pattern of safe device usage that further confirms the authenticity of the consumer who initiated the transaction.' type: string location: description: 'Geographic coordinates of the device. Contains the latitude and longitude of the device used when the cardholder was authenticated during checkout. This field helps to determine if the transaction was initiated from an unexpected location.' type: string phone_number: description: 'Telephone number of the device. Contains the phone number that was used to authenticate the consumer during checkout, or the consumer''s preferred phone number. The presence of the phone number helps establish the consumer''s authenticity when matching the phone number provided during checkout to a list of known phone numbers for the consumer.' type: string type: object card_response: description: Contains information about the card used in the transaction. properties: 3csc: type: string account_tokens: description: List of account tokens associated with the card items: type: string type: array activation_actions: $ref: '#/components/schemas/activation_actions' barcode: description: Barcode printed on the card, expressed as numerals. type: string bulk_issuance_token: description: Unique identifier of the bulk card order. type: string card_product_token: description: Unique identifier of the card product. type: string chip_cvv_contactless_number: type: string chip_cvv_number: description: Three-digit card verification value (ICVV) stored on the chip of the card. type: string contactless_exemption_counter: description: 'Running count of the contactless transactions successfully completed since the last strong customer authentication (SCA) challenge was issued. You can limit the number of contactless transactions that can be performed without issuing an SCA challenge at the card product level. For more information about strong customer authentication, see <>.' format: int32 type: integer contactless_exemption_total_amount: description: 'Running total of the money spent in contactless transactions successfully completed since the last strong customer authentication (SCA) challenge was issued. You can limit the total amount that can be spent in contactless transactions without issuing an SCA challenge at the card product level. For more information about strong customer authentication, see <>.' type: number contactless_exemption_transaction_currency: description: Indicates the currency type of the transaction. type: string created_time: description: Date and time when the resource was created, in UTC. format: date-time type: string cvv_number: description: Three-digit card verification value (CVV2 or CVC2) printed on the card. type: string expedite: default: false description: A value of `true` indicates that you requested expedited processing of the card from your card fulfillment provider. type: boolean expiration: description: Expiration date in `MMyy` format. type: string expiration_time: description: Expiration date and time, in UTC. format: date-time type: string fulfillment: $ref: '#/components/schemas/CardFulfillmentResponse' fulfillment_status: description: 'Card fulfillment status: * *ISSUED:* Initial state of all newly created/issued cards. * *ORDERED:* Card ordered through the card fulfillment provider. * *REORDERED:* Card reordered through the card fulfillment provider. * *REJECTED:* Card rejected by the card fulfillment provider. * *SHIPPED:* Card shipped by the card fulfillment provider. * *DELIVERED:* Card delivered by the card fulfillment provider. * *DIGITALLY_PRESENTED:* Card digitally presented using the `/cards/{token}/showpan` endpoint; does not affect the delivery of physical cards.' enum: - ISSUED - ORDERED - REORDERED - REJECTED - SHIPPED - DELIVERED - DIGITALLY_PRESENTED type: string instrument_type: description: 'Instrument type of the card: * *PHYSICAL_MSR:* A physical card with a magnetic stripe. This is the default physical card type. * *PHYSICAL_ICC:* A physical card with an integrated circuit, or "chip." * *PHYSICAL_CONTACTLESS:* A physical card that uses radio frequency identification (RFID) or near-field communication (NFC) to enable payment over a secure radio interface. * *PHYSICAL_COMBO:* A physical card with a chip that also supports contactless payments. * *VIRTUAL_PAN:* A virtual card with a primary account number (PAN).' enum: - PHYSICAL_MSR - PHYSICAL_ICC - PHYSICAL_CONTACTLESS - PHYSICAL_COMBO - VIRTUAL_PAN type: string last_four: description: Last four digits of the card primary account number (PAN). type: string last_modified_time: description: Date and time when the resource was last modified, in UTC. format: date-time type: string metadata: additionalProperties: type: string description: Associates customer-provided metadata with the card. type: object new_pan_from_card_token: description: Reissues the specified card (known as the "source" card) with a new primary account number (PAN). type: string pan: description: Primary account number (PAN) of the card. type: string pin_is_set: default: false description: Specifies if the personal identification number (PIN) has been set for the card. type: boolean reissue_pan_from_card_token: description: Reissues the specified card (known as the "source" card). type: string state: description: Indicates the state of the card. enum: - ACTIVE - SUSPENDED - TERMINATED - UNSUPPORTED - UNACTIVATED - LIMITED type: string state_reason: description: 'Descriptive reason for why the card is in its current state. For example, "Card activated by cardholder".' type: string token: description: Unique identifier of the card. type: string translate_pin_from_card_token: description: Copies the personal identification number (PIN) from the specified source card to the newly created card. type: string user: $ref: '#/components/schemas/user_card_holder_response' user_token: description: Unique identifier of the cardholder. type: string required: - barcode - card_product_token - created_time - expiration - expiration_time - fulfillment_status - last_four - last_modified_time - pan - pin_is_set - state - state_reason - token - user_token type: object airline: description: Contains information about airline-related transactions. properties: depart_date: description: The date and time of departure. format: date-time type: string origination_city: description: The city where the flight originates. type: string passenger_name: description: The name of the passenger. type: string type: object BillingAddress: properties: address: type: string compressed_zip: type: string first_name: type: string last_name: type: string zip: type: string type: object funding_source_model: description: Contains funding source information for the transaction, including the funding type and time. discriminator: mapping: bankaccount: '#/components/schemas/bank_account_funding_source_model' chargeback: '#/components/schemas/chargeback_funding_source_model' directdeposit: '#/components/schemas/direct_deposit_funding_source_model' paymentcard: '#/components/schemas/payment_card_funding_source_model' program: '#/components/schemas/program_funding_source_model' programgateway: '#/components/schemas/program_gateway_funding_source_model' propertyName: type properties: active: default: false description: Whether the funding source is active. type: boolean created_time: description: Date and time when the funding source was created, in UTC. format: date-time type: string is_default_account: default: false description: Whether the GPA order unload's funding source is the default funding account. type: boolean last_modified_time: description: Date and time when the funding source was last modified, in UTC. format: date-time type: string token: description: Unique identifier of the funding source. type: string type: description: Funding type of the funding source. type: string required: - active - created_time - is_default_account - last_modified_time - token - type type: object images: description: Specifies personalized images that appear on the card. properties: card: $ref: '#/components/schemas/images_card' carrier: $ref: '#/components/schemas/ImagesCarrier' carrier_return_window: $ref: '#/components/schemas/images_carrier_return_window' signature: $ref: '#/components/schemas/images_signature' type: object card_security_code_verification: description: Contains information about a verification check performed on the card's security code. properties: response: $ref: '#/components/schemas/response' type: description: 'Indicates the type of security code. Can have these possible values: * *CVV1* – the security code stored in the magnetic stripe on the card. * *CVV2* – the security code printed on the card. * *ICVV* – the security code stored on the chip of the card. * *DCVV* – a dynamic security code used in some contactless payments when a card or device is tapped against the card reader.' enum: - CVV1 - CVV2 - ICVV - DCVV type: string required: - response - type type: object network_fraud_view: description: Contains network-provided information about fraud determinations. properties: account_risk_score: 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.' type: string account_risk_score_reason_code: description: _(Visa only)_ Unique code that describes the main driver of the `account_risk_score`. type: string card_not_present_transaction_risk_score: description: '_(Visa only)_ Visa-provided score ranking the risk of fraud for a card-not-present transaction. A higher score indicates higher risk. Useful for making authorization decisions.' type: string dii_score: description: Mastercard Digital Identity Insights risk score, where `0` indicates the lowest risk and `9` indicates the highest risk. type: string dii_score_reason_code: description: Mastercard Digital Identity Insights risk score reason code, where `AA` indicates the lowest risk, and `ZZ` indicates the highest risk. type: string transaction_account_attack_intelligence_score: description: '_(Visa only)_ Visa-provided score ranking the risk of an account enumeration attack in a card-not-present transaction. A higher score indicates higher risk. A score of 00 indicates insufficient data to determine risk. Useful for making authorization decisions.' type: string transaction_risk_score: description: 'Network-provided risk score for the transaction. A higher score indicates higher risk. Useful for making authorization decisions.' format: int32 type: integer transaction_risk_score_reason_code: description: 'For Mastercard only. Unique code that describes the main driver of the `transaction_risk_score`.' type: string transaction_risk_score_reason_description: description: 'For Mastercard only. Description of the `transaction_risk_score_reason_code`.' type: string type: object cardholder_metadata: description: Contains customer-provided information about the cardholder that performed the transaction. properties: metadata: additionalProperties: type: string description: Associates customer-provided metadata with the cardholder. type: object type: object BillPayResponse: properties: amount: type: string biller_token: type: string created_time: type: string delivery_date: type: string last_modified_time: type: string payment_token: type: string payment_type: type: string processing_date: type: string status: type: string user_token: type: string type: object authorization_advice_model: properties: amount: type: number network_fees: items: $ref: '#/components/schemas/network_fee_model' type: array original_transaction_token: maxLength: 36 minLength: 1 type: string transaction_options: $ref: '#/components/schemas/transaction_options' vcn_data: $ref: '#/components/schemas/vcn_data_model' webhook: $ref: '#/components/schemas/webhook' required: - amount - original_transaction_token type: object triggered_rule: description: Provides a list of rules triggered by a fraud event, along with the information on tags and rule characteristics. properties: alert: description: Indicates if the rule triggered an alert. type: boolean entity_type: description: The entity type where the triggered rule was defined. type: string rule_name: description: Name of the rule, as defined in the Real-Time Decisioning dashboard that was triggered. type: string suppress_alert: description: Indicates if the triggered rule has `suppress_alert` in the definition. type: boolean tags: description: All the tags defined in the triggered rule. items: $ref: '#/components/schemas/tag' type: array type: object risk_assessment: description: Contains the digital wallet provider's risk assessment for provisioning the digital wallet token. properties: score: description: Wallet provider's decision as to whether the digital wallet token should be provisioned. type: string version: description: Wallet provider's risk assessment version. type: string type: object DepositDepositResponse: description: Contains information about a direct deposit. properties: amount: description: Amount being debited or credited. type: number business_token: description: The unique identifier of the business account holder. type: string company_discretionary_data: description: Company-specific data provided by the direct deposit originator. type: string company_entry_description: description: Company-specific data provided by the direct deposit originator. type: string company_identification: description: Alphanumeric code that identifies the direct deposit originator. type: string company_name: description: Name of the direct deposit originator. type: string created_time: description: Date and time when the direct deposit account was created. format: date-time type: string direct_deposit_account_token: description: The unique identifier of the direct deposit account. type: string individual_identification_number: description: Accounting number by which the recipient is known to the direct deposit originator. type: string individual_name: description: Name of the direct deposit recipient. type: string last_modified_time: description: Date and time when the direct deposit account was last modified. format: date-time type: string settlement_date: description: Date and time when the credit or debit is applied. format: date-time type: string standard_entry_class_code: description: Three-letter code identifying the type of entry. type: string state: description: Current status of the direct deposit record. enum: - PENDING - APPLIED - REVERSED - REJECTED type: string state_reason: description: Explanation for why the direct deposit record is in the current state. type: string state_reason_code: description: Standard code describing the reason for the current state. type: string token: description: The unique identifier of the direct deposit record. type: string type: description: Determines whether funds are being debited from or credited to the account. enum: - CREDIT - DEBIT type: string user_token: description: The unique identifier of the user account holder. type: string type: object images_card: description: Specifies personalized images that appear on the card. properties: name: description: Specifies a PNG image to display on the card. type: string thermal_color: description: Specifies the color of the image displayed on the card. type: string type: object account_balance: properties: balances: additionalProperties: $ref: '#/components/schemas/CurrencyBalance' type: object default_currency_code: type: string description: type: string impacted_amount: type: number last_updated_time: format: date-time type: string token: type: string type: type: string type: object store_response_model: properties: active: default: true type: boolean address1: maxLength: 255 minLength: 0 type: string address2: maxLength: 255 minLength: 0 type: string city: maxLength: 40 minLength: 0 type: string contact: maxLength: 40 minLength: 0 type: string contact_email: maxLength: 40 minLength: 0 type: string country: maxLength: 40 minLength: 0 type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string keyed_auth_cvv_enforced: default: false type: boolean last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string latitude: format: float type: number longitude: format: float type: number merchant_token: maxLength: 36 minLength: 0 type: string mid: maxLength: 50 minLength: 1 type: string name: maxLength: 40 minLength: 0 type: string network_mid: maxLength: 50 minLength: 1 type: string partial_approval_capable: default: false type: boolean partial_auth_flag: default: true description: 1 char max type: boolean phone: maxLength: 10 minLength: 0 type: string postal_code: maxLength: 10 minLength: 0 type: string province: maxLength: 20 minLength: 0 type: string state: maxLength: 255 minLength: 0 type: string token: description: The unique identifier of the merchant maxLength: 36 minLength: 1 type: string zip: maxLength: 10 minLength: 0 type: string required: - address1 - city - created_time - last_modified_time - merchant_token - mid - name - state type: object fee: description: Contains details about the fee. properties: amount: description: Amount of the fee. type: number created_time: description: Date and time when the `fees` object was created, in UTC. format: date-time type: string currency_code: description: Three-digit ISO 4217 currency code. type: string last_modified_time: description: Date and time when the `fees` object was last modified, in UTC. format: date-time type: string memo: description: Optional property to be used as Dispaly field when the fee is applied 255 char max type: string name: description: Name of the fee. type: string tags: description: Descriptive metadata about the fee. type: string token: description: Unique identifier of the `fees` object. type: string required: - amount - created_time - currency_code - last_modified_time - name - token type: object fraud_view: description: Contains one or more fraud determinations by the card network that apply to either the transaction or the cardholder's account. properties: issuer_processor: $ref: '#/components/schemas/issuer_fraud_view' network: $ref: '#/components/schemas/network_fraud_view' network_account_intelligence_score: $ref: '#/components/schemas/network_account_intelligence_score' type: object installment_data: description: Contains the installment plan identifier used by the Visa Transaction Matching Service for Issuers. properties: installment_plan_identifier: description: '(_Visa only_) Visa Transaction Matching Service for Issuers identifier. This identifier matches a transaction on the Marqeta platform to an installment plan or Pay by Points transaction on the Visa card network.' type: string type: object merchant_response_model: properties: active: default: true type: boolean address1: maxLength: 255 minLength: 0 type: string address2: maxLength: 255 minLength: 0 type: string city: maxLength: 40 minLength: 0 type: string contact: maxLength: 40 minLength: 0 type: string contact_email: maxLength: 40 minLength: 0 type: string country: maxLength: 40 minLength: 0 type: string created_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string last_modified_time: description: yyyy-MM-ddTHH:mm:ssZ format: date-time type: string latitude: format: float type: number longitude: format: float type: number name: maxLength: 40 minLength: 0 type: string partial_auth_flag: default: true type: boolean phone: maxLength: 10 minLength: 0 type: string province: maxLength: 20 minLength: 0 type: string state: maxLength: 2 minLength: 0 type: string token: description: The unique identifier of the merchant maxLength: 36 minLength: 1 type: string zip: maxLength: 10 minLength: 0 type: string required: - created_time - last_modified_time - name type: object gpa: description: Defines the type of order. properties: reload_amount: description: 'Available balance on the card after the reload has completed. This value must be greater than or equal to the value of `trigger_amount`. Note that this is not the same as the amount added to the card, which will vary from reload to reload.' exclusiveMinimum: false minimum: 0.01 type: number trigger_amount: description: 'Threshold that determines when the reload happens. The reload is triggered when the card balance falls below this amount.' exclusiveMinimum: false minimum: 0.01 type: number required: - reload_amount - trigger_amount type: object gateway_response: description: Contains information from the gateway in response to a funding request. properties: code: description: Code received from the gateway. type: string data: $ref: '#/components/schemas/jit_program_response' required: - code type: object card_options: properties: billing_address: $ref: '#/components/schemas/BillingAddress' card_present: default: false type: boolean cvv: maxLength: 3 minLength: 0 type: string expiration: maxLength: 4 minLength: 4 type: string type: object terminal_model: description: 'Contains information about the point of sale, including details on how the card was presented. Returned if provided by the card network, and the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests.' properties: card_presence: description: Indicates whether the card was present during the transaction. type: string cardholder_presence: description: Indicates whether the cardholder was present during the transaction. type: string partial_approval_capable: description: Indicates whether the card acceptor or terminal supports partial-approval transactions. type: string pin_present: description: Indicates whether the cardholder entered a PIN during the transaction. type: string special_condition_indicator: description: 'Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction. These transactions typically involve non-financial institutions.' enum: - UNSPECIFIED - CRYPTOCURRENCY_PURCHASE - QUASI_CASH - DEBT_PAYMENT - CENTRAL_BANK_DIGITAL_CURRENCY_PURCHASE - STABLECOIN_PURCHASE - BLOCKCHAIN_NATIVE_TOKEN_PURCHASE - NON_FUNGIBLE_TOKEN_PURCHASE type: string tid: description: Card acceptor or terminal identification number. type: string transaction_initiated_by: description: Specifies the initiator of the transaction. enum: - CONSUMER - MERCHANT - UNKNOWN - MARQETA - NETWORK type: string transaction_initiated_category: description: Specifies the category of a point-of-sale transaction. enum: - CARD_ON_FILE - RECURRING_VAR_AMT_FIXED_FREQ - RECURRING_PAYMENT - INSTALLMENT_PAYMENT - UNSCHEDULED_PAYMENT - PARTIAL_SHIPMENT - DELAYED_PAYMENT - NO_SHOW - RESUBMISSION - DEFERRED_BILLING - ACCOUNT_INQUIRY - INCREMENTAL_AUTHORIZATION - REAUTHORIZATION type: string type: object ShippingInformationResponse: description: 'Specifies shipping details for the order. This object is returned if it exists in the resource.' properties: care_of_line: description: 'Specifies the value of the care of (C/O) line on the mailing carrier. This field is returned if it exists in the resource.' type: string method: description: 'Specifies the shipping service. This field is returned if it exists in the resource.' enum: - LOCAL_MAIL - LOCAL_MAIL_PACKAGE - GROUND - TWO_DAY - OVERNIGHT - INTERNATIONAL - INTERNATIONAL_PRIORITY - LOCAL_PRIORITY - FEDEX_EXPEDITED - FEDEX_REGULAR - UPS_EXPEDITED - UPS_REGULAR - USPS_EXPEDITED - USPS_REGULAR type: string recipient_address: $ref: '#/components/schemas/FulfillmentAddressResponse' return_address: $ref: '#/components/schemas/FulfillmentAddressResponse' type: object chargeback_response: description: Contains the chargeback object associated with this transaction if a chargeback has been initiated. properties: amount: description: Amount of the chargeback. exclusiveMinimum: false minimum: 0.01 type: number channel: description: Channel the chargeback came through. enum: - GATEWAY - GATEWAY_AUTOMATED - ISSUER - ISSUER_AUTOMATED type: string created_time: description: 'Date and time when the chargeback was created. Not returned for transactions when the associated chargeback is in the `INITIATED` state.' format: date-time type: string credit_user: default: false description: Whether to credit the user for the chargeback amount. type: boolean currency_code: maxLength: 3 minLength: 3 type: string last_modified_time: description: 'Date and time when the chargeback was last modified. Not returned for transactions when the associated chargeback is in the `INITIATED` state.' format: date-time type: string memo: description: Additional comments about the chargeback. maxLength: 1024 minLength: 1 type: string network: description: Network handling the chargeback. enum: - MARQETA - DISCOVER - MASTERCARD - PULSE - VISA - AMERICANEXPRESS type: string network_case_id: description: Network-assigned identifier of the chargeback. maxLength: 50 minLength: 0 type: string reason_code: description: Identifies the standardized reason for the chargeback. type: string state: description: State of the case. enum: - INITIATED - REPRESENTMENT - PREARBITRATION - ARBITRATION - CASE_WON - CASE_LOST - NETWORK_REJECTED - WITHDRAWN - RETRIEVAL_REQUEST - RETRIEVAL_RESPONSE type: string token: description: Unique identifier of the chargeback. maxLength: 36 minLength: 1 type: string transaction_token: description: Unique identifier of the transaction being charged back. maxLength: 36 minLength: 1 type: string required: - amount - channel - created_time - credit_user - last_modified_time - network - state - token - transaction_token type: object jit_address_verification: description: Contains address verification data used to make JIT Funding decisions. properties: gateway: $ref: '#/components/schemas/address_verification_source' issuer: $ref: '#/components/schemas/address_verification_source' request: $ref: '#/components/schemas/avs_information' type: object webhook: properties: endpoint: description: Valid URL maxLength: 512 minLength: 1 type: string password: description: Authentication password type: string secret: description: Authentication secret type: string username: description: Authentication username type: string required: - endpoint - password - username type: object xml: name: webhook ATCInformationModel: properties: atc_discrepancy_indicator: type: string atc_discrepancy_value: type: number atc_value: type: number type: object text_value: properties: value: description: Line of personalized text printed on the card. type: string type: object response: description: Response codes and memos for account name verification, address verification, card security verification, and transactions. properties: additional_information: description: 'Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.' type: string code: description: 'Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. * `0` indicates no validation was performed * `1` indicates the match was unsuccessful (not matched) * `2` indicates the match was partial * `3` indicates the match was exact For example: [cols="2,3,3,3,3"] !=== ! Code ! First Name ! Middle Name ! Last Name ! Full Name ! `0000` ! Not validated ! Not validated ! Not validated ! Not validated ! `1111` ! Not matched ! Not matched ! Not matched ! Not matched ! `3333` ! Exact match ! Exact match ! Exact match ! Exact match ! `1232` ! Not matched ! Partial match ! Exact match ! Partial match !=== For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: [cols="2,3,3"] !=== ! Code ! Address ! Postal Code ! `0000` ! Match ! Match ! `0001` ! Match ! Not matched ! `0100` ! Not matched ! Match ! `0101` ! Not matched ! Not matched ! `0200` ! Data not present ! Match ! `0201` ! Data not present ! Not matched ! `0002` ! Match ! Data not present ! `0102` ! Not matched ! Data not present ! `0303` ! Not validated ! Not validated !=== For card security verification, the code indicates whether the verification check passed and can have these possible values: * `0000` – Passed * `0001` – Did not pass For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see <>.' type: string memo: description: Additional text that describes the response. type: string required: - code type: object card_acceptor_model: properties: address: maxLength: 255 minLength: 0 type: string business_registration_id: type: string business_registration_id_type: type: string city: maxLength: 40 minLength: 0 type: string country: type: string customer_service_phone: type: string ecommerce_security_level_indicator: type: string geographic_coordinates: type: string legal_business_name: type: string mcc: maxLength: 5 minLength: 0 type: string name: maxLength: 50 minLength: 0 type: string partial_approval_capable: default: false type: boolean phone: type: string service_geographic_coordinates: type: string state: type: string url: type: string zip: maxLength: 10 minLength: 0 type: string type: object fee_detail: description: Contains details about a fee. properties: fee: $ref: '#/components/schemas/fee' memo: description: Additional text describing the fee. maxLength: 99 minLength: 1 type: string overrideAmount: description: Dynamic fee amount that overrides the `fee.amount` field value. type: number tags: description: Descriptive metadata about the fee. maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the fee. maxLength: 36 minLength: 1 type: string transaction_token: description: Unique identifier of the fee transaction. type: string required: - fee - token - transaction_token type: object network_fee_model: description: Contains card network fees assessed against the cardholder. properties: amount: description: Amount of the network fee. type: number credit_debit: description: 'Indicates whether the fee is a credit or a debit. * *C* indicates a credit * *D* indicates a debit' enum: - C - D type: string currency: description: 'Type of currency used when assessing a `CROSS_BORDER_ISSUER_FEE` or `INTERCHANGE_FEE` on Mastercard multi-currency transactions. Three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"].' type: string type: description: 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 type: string type: object program_reserve_transaction_response: properties: amount: description: 'Amount of the program reserve account credit or debit. Sometimes referred to as a _program funding account_.' type: number created_time: description: Date and time when the resource was created, in UTC. format: date-time type: string currency_code: description: Three-digit ISO 4217 currency code. type: string is_collateral: type: boolean last_modified_time: description: The date and time when the resource was last modified, in UTC. format: date-time type: string memo: description: Memo or note describing the transaction. type: string state: description: Transaction state. enum: - PENDING - COMPLETE type: string tags: description: Comma-delimited list of tags describing the transaction. type: string token: description: The unique identifier of the transaction response. type: string transaction_token: description: Unique identifier of the transaction. type: string type: description: Transaction type. enum: - CREDIT - DEBIT - PENDING_CREDIT - PENDING_DEBIT type: string required: - created_time - last_modified_time type: object address_verification: description: Contains address verification information. properties: name: description: Name of the cardholder. type: string postal_code: description: Postal code. type: string street_address: description: Street address provided by the cardholder. type: string zip: description: United States ZIP code. type: string type: object ImagesCarrier: description: Specifies personalized images that appear on the card carrier. properties: message_1: description: Specifies a custom message that appears on the card carrier. type: string name: description: Specifies a PNG image to display on the card carrier. type: string type: object auto_reload_association: description: 'Specifies the scope of the auto reload. Input no more than one field. If no value is supplied, the auto reload applies at the program level.' properties: account_template_token: maxLength: 36 minLength: 1 type: string business_token: description: 'Unique identifier of the business for which the auto reload is configured. Send a `GET` request to `/businesses` to retrieve business tokens.' maxLength: 36 minLength: 1 type: string card_product_token: description: 'Unique identifier of the card product for which the auto reload is configured. Send a `GET` request to `/cardproducts` to retrieve card product tokens.' maxLength: 36 minLength: 1 type: string user_token: description: 'Unique identifier of the user for which the auto reload is configured. Send a `GET` request to `/users` to retrieve user tokens.' maxLength: 36 minLength: 1 type: string type: object network_account_intelligence_score: description: Account intelligence score information, as provided by the Mastercard network. properties: name: description: The name, as provided by the Mastercard network. type: string service_type: description: The service type, as provided by the Mastercard network. type: string value: description: The value, as provided by the Mastercard network. type: string type: object preceding_transaction: description: 'Returned for `authorization.clearing` transaction types following a financial advice. Contains information about the preceding transaction.' properties: amount: description: Amount of the preceding transaction. type: number token: description: Unique identifier of the preceding transaction. type: string type: object digital_wallet_token: description: 'Contains information about the digital wallet that funded the transaction. Returned for all transactions funded by a digital wallet or related to digital wallet token provisioning. For more on digital wallets, see the <> API reference and <> developer guide.' properties: address_verification: $ref: '#/components/schemas/address_verification' card_token: description: Unique identifier of the card. type: string created_time: description: Date and time when the digital wallet token object was created, in UTC. format: date-time type: string device: $ref: '#/components/schemas/device' fulfillment_status: description: 'Digital wallet token''s provisioning status. For fulfillment status descriptions, see <>.' type: string issuer_eligibility_decision: description: 'The Marqeta platform''s decision as to whether the digital wallet token should be provisioned. * *0000* – The token should be provisioned. * *token.activation.verification.required* – Provisioning is pending; further action is required for completion. For all other values, check the value of the `fulfillment_status` field to definitively ascertain the provisioning outcome. *NOTE:* The value `invalid.cid` indicates an invalid CVV2 number.' type: string last_modified_time: description: Date and time when the digital wallet token object was last modified, in UTC. format: date-time type: string metadata: $ref: '#/components/schemas/digital_wallet_token_metadata' state: description: 'State of the digital wallet token. For state descriptions, see <>.' type: string state_reason: description: Reason why the digital wallet token transitioned to its current state. type: string token: description: Unique identifier of the digital wallet token. type: string token_service_provider: $ref: '#/components/schemas/token_service_provider' transaction_device: $ref: '#/components/schemas/transaction_device' user: $ref: '#/components/schemas/user_card_holder_response' wallet_provider_profile: $ref: '#/components/schemas/wallet_provider_profile' type: object pos: description: 'Contains information about the point of sale, including details on how the card was presented. Returned if provided by the card network, and the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests.' properties: card_data_input_capability: description: How the terminal accepts card data. enum: - UNKNOWN - NO_TERMINAL - MAG_STRIPE - MAG_STRIPE_CONTACTLESS - MAG_STRIPE_KEY_ENTRY - CHIP - CHIP_CONTACTLESS - CHIP_MAG_STRIPE - CHIP_MAG_STRIPE_KEY_ENTRY - KEY_ENTRY - OCR - MICR - BAR_CODE - CREDENTIALS_ON_FILE type: string card_holder_presence: default: false description: Whether the cardholder was present during the transaction. type: boolean card_presence: default: false description: Whether the card was present during the transaction. type: boolean cardholder_authentication_method: description: Method used to authenticate the cardholder. enum: - UNSPECIFIED - NON_AUTHENTICATED - SIGNATURE - PIN - ID_VERIFIED - ELECTRONIC_SIGNATURE - BIOMETRIC - BIOGRAPHIC - MANUAL_SIGNATURE - ELECTRONIC_TICKET_ENVIRONMENT type: string country_code: description: Country code of the card acceptor or terminal. type: string county: description: County of the card acceptor or terminal. type: string is_installment: default: false description: Whether the transaction is an installment payment. type: boolean is_recurring: default: false description: Whether the transaction is recurring. type: boolean pan_entry_mode: description: Method used for capturing the card primary account number (PAN) during the transaction. enum: - UNKNOWN - MANUAL - MAG_STRIPE - MAG_STRIPE_CONTACTLESS - BAR_CODE - OCR - MICR - CHIP - CHIP_CONTACTLESS - CARD_ON_FILE - CHIP_FALLBACK - OTHER - KEY_ENTERED - CREDENTIALS_ON_FILE - KEYED_CARD_PCSC - MAG_STRIPE_READ_KEYED_PCSC type: string partial_approval_capable: default: false description: Indicates whether the card acceptor or terminal supports partial-approval transactions. type: boolean pin_entry_mode: description: 'Indicates whether the card acceptor or terminal can capture card personal identification numbers (PINs). *NOTE:* This field does not indicate whether a PIN was entered.' enum: - UNKNOWN - 'TRUE' - 'FALSE' - DEFECTIVE type: string pin_present: default: false description: Indicates whether the cardholder entered a PIN during the transaction. type: boolean purchase_amount_only: default: false description: Indicates whether the card acceptor or terminal supports purchase-only approvals. type: boolean special_condition_indicator: description: 'Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction. These transactions typically involve non-financial institutions.' enum: - UNSPECIFIED - CRYPTOCURRENCY_PURCHASE - QUASI_CASH - DEBT_PAYMENT - CENTRAL_BANK_DIGITAL_CURRENCY_PURCHASE - STABLECOIN_PURCHASE - BLOCKCHAIN_NATIVE_TOKEN_PURCHASE - NON_FUNGIBLE_TOKEN_PURCHASE type: string state: description: State, province, or territory of the card acceptor or terminal. type: string terminal_attendance: description: Whether the card acceptor/terminal was attended. enum: - UNSPECIFIED - ATTENDED - UNATTENDED - NO_TERMINAL - MOBILE_REMOTE - TRANSIT_ACCESS_TERMINAL type: string terminal_id: description: Card acceptor or terminal identification number. type: string terminal_location: description: Location of the card acceptor/terminal. enum: - ON_PREMISE - ON_PREMISE_CARDHOLDER - OFF_PREMISE_CARDHOLDER - ON_PREMISE_MERCHANT - OFF_PREMISE_MERCHANT - NO_TERMINAL - MOBILE_REMOTE - TRANSIT_ACCESS_TERMINAL - UNSPECIFIED type: string terminal_type: description: Type of card acceptor/terminal. enum: - AUTO_DISPENSER_WITH_PIN - SELF_SERVICE - LIMITED_AMOUNT - IN_FLIGHT - ECOMMERCE - TRANSPONDER type: string transaction_initiated_by: description: Specifies the initiator of the transaction. enum: - CONSUMER - MERCHANT - UNKNOWN - MARQETA - NETWORK type: string transaction_initiated_category: description: Specifies the category of a point-of-sale transaction. enum: - CARD_ON_FILE - RECURRING_VAR_AMT_FIXED_FREQ - RECURRING_PAYMENT - INSTALLMENT_PAYMENT - UNSCHEDULED_PAYMENT - PARTIAL_SHIPMENT - DELAYED_PAYMENT - NO_SHOW - RESUBMISSION - DEFERRED_BILLING - ACCOUNT_INQUIRY - INCREMENTAL_AUTHORIZATION - REAUTHORIZATION type: string zip: description: United States ZIP code of the card acceptor or terminal. type: string type: object account: description: Contains information related to the cardholder and provided by the digital wallet provider. properties: email_address: description: Digital wallet provider's email address for the cardholder. type: string id: description: Digital wallet provider's identity number for the cardholder. type: string score: description: Score from the digital wallet provider. type: string type: object FulfillmentAddressResponse: description: Specifies a fulfillment shipping or return address. properties: address1: description: 'Number and street of the address. This field is returned if it exists in the resource.' maxLength: 255 minLength: 0 type: string address2: description: 'Additional address information. This field is returned if it exists in the resource.' maxLength: 255 minLength: 0 type: string city: description: 'City of the address. This field is returned if it exists in the resource.' maxLength: 40 minLength: 0 type: string country: description: 'Country of the address. This field is returned if it exists in the resource.' maxLength: 40 minLength: 0 type: string first_name: description: 'First name of the addressee. This field is returned if it exists in the resource.' maxLength: 40 minLength: 0 type: string last_name: description: 'Last name of the addressee. This field is returned if it exists in the resource.' maxLength: 40 minLength: 0 type: string middle_name: description: 'Middle name of the addressee. This field is returned if it exists in the resource.' maxLength: 40 minLength: 0 type: string phone: description: 'Telephone number of the addressee. This field is returned if it exists in the resource.' maxLength: 20 minLength: 0 type: string postal_code: description: 'Postal code of the address. This field is returned if it exists in the resource.' maxLength: 10 minLength: 0 type: string state: description: 'State or province of the address. This field is returned if it exists in the resource.' maxLength: 32 minLength: 0 type: string zip: description: 'United States ZIP code of the address. This field is returned if it exists in the resource.' maxLength: 10 minLength: 0 type: string type: object peer_transfer_response: description: Contains information about an intra-account transfer, including sender and recipient tokens, transfer amount, and currency code. properties: amount: description: Amount of the transfer. type: number created_time: format: date-time type: string currency_code: description: Three-digit ISO 4217 currency code. type: string memo: description: Additional descriptive text about the intra-account transfer. type: string recipient_business_token: description: Specifies the business account holder that receives funds. type: string recipient_user_token: description: Specifies the user account holder that receives funds. type: string sender_business_token: description: Specifies the business account holder that sends funds. type: string sender_user_token: description: Specifies the user account holder that sends funds. type: string tags: description: Metadata about the intra-account transfer. type: string token: description: Unique identifier of the intra-account transfer request. type: string required: - amount - created_time - currency_code - token type: object real_time_fee_group: description: Contains information about a real-time fee group. properties: active: default: false description: Indicates whether the real-time fee group is active. type: boolean created_time: description: Date and time when the real-time fee group was created, in UTC. format: date-time type: string fee_tokens: description: Specifies the fees in this real-time fee group. items: type: string type: array uniqueItems: true last_modified_time: description: Date and time when the real-time fee group was last modified, in UTC. format: date-time type: string name: description: Descriptive name for the real-time fee group. type: string token: description: Unique identifier of the real-time fee group. type: string required: - active - name - token type: object IdentificationResponseModel: description: Contains identifications associated with the cardholder. properties: expiration_date: description: Expiration date of the identification, if applicable. readOnly: true type: string issuing_country: readOnly: true type: string type: description: Type of identification. enum: - SSN - TIN - SIN - NIN - PASSPORT_NUMBER - DRIVERS_LICENSE - BUSINESS_NUMBER - BUSINESS_TAX_ID - TAXPAYER_REFERENCE readOnly: true type: string value: description: Number associated with the identification. readOnly: true type: string type: object token_service_provider: description: Contains information held and provided by the token service provider (card network). properties: correlation_id: description: 'For Mastercard only. Unique value representing a tokenization request.' type: string pan_reference_id: description: Unique identifier of the digital wallet token primary account number (PAN) within the card network. type: string token_assurance_level: description: 'For Mastercard only. Represents the confidence level in the digital wallet token.' type: string token_eligibility_decision: description: Digital wallet's decision as to whether the digital wallet token should be provisioned. type: string token_expiration: description: Expiration date of the digital wallet token. type: string token_pan: description: Primary account number (PAN) of the digital wallet token. type: string token_reference_id: description: Unique identifier of the digital wallet token within the card network. type: string token_requestor_id: description: 'Unique numerical identifier of the token requestor within the card network. These ID numbers map to `token_requestor_name` field values as follows: *Mastercard* * 50110030273 – `APPLE_PAY` * 50120834693 – `ANDROID_PAY` * 50139059239 – `SAMSUNG_PAY` *Visa* * 40010030273 – `APPLE_PAY` * 40010075001 – `ANDROID_PAY` * 40010043095 – `SAMSUNG_PAY` * 40010075196 – `MICROSOFT_PAY` * 40010075338 – `VISA_CHECKOUT` * 40010075449 – `FACEBOOK` * 40010075839 – `NETFLIX` * 40010077056 – `FITBIT_PAY` * 40010069887 – `GARMIN_PAY`' type: string token_requestor_name: description: 'Name of the token requestor within the card network. *NOTE:* The list of example values for this field is maintained by the card networks and is subject to change.' type: string token_score: description: Token score assigned by the digital wallet. type: string token_service_provider_id: type: string token_type: description: Type of the digital wallet token. type: string required: - pan_reference_id type: object user_card_holder_response: description: Contains information about a cardholder. properties: account_holder_group_token: description: Associates the specified account holder group with the cardholder. maxLength: 36 minLength: 0 type: string active: default: false description: Specifies if the cardholder is in the `ACTIVE` state on the Marqeta platform. type: boolean address1: description: Cardholder's address. maxLength: 255 minLength: 0 type: string address2: description: Additional address information for the cardholder. maxLength: 255 minLength: 0 type: string authentication: $ref: '#/components/schemas/Authentication' birth_date: description: Cardholder's date of birth. type: string birth_place: description: Country where the cardholder was born. maxLength: 255 minLength: 0 type: string business_token: description: Unique identifier of the business resource. type: string city: description: City where the cardholder resides. maxLength: 40 minLength: 0 type: string company: description: Company name. maxLength: 255 minLength: 0 type: string corporate_card_holder: default: false description: Specifies if the cardholder holds a corporate card. type: boolean country: description: Country where the cardholder resides. maxLength: 40 minLength: 0 type: string created_time: description: Date and time when the resource was created, in UTC. format: date-time type: string email: description: Valid email address of the cardholder. maxLength: 255 minLength: 1 type: string first_name: description: Cardholder's first name. maxLength: 40 minLength: 0 type: string gender: description: Gender of the cardholder. enum: - F - M maxLength: 1 minLength: 0 type: string honorific: description: 'Cardholder''s title or prefix: Dr., Miss, Mr., Ms., and so on.' maxLength: 10 minLength: 0 type: string id_card_expiration_date: description: Expiration date of the cardholder's identification. readOnly: true type: string id_card_number: description: Cardholder's identification card number. maxLength: 255 minLength: 0 type: string identifications: description: One or more objects containing identifications associated with the cardholder. items: $ref: '#/components/schemas/IdentificationResponseModel' type: array ip_address: description: Cardholder's IP address. maxLength: 39 minLength: 0 type: string last_modified_time: description: Date and time when the resource was last updated, in UTC. format: date-time type: string last_name: description: Cardholder's last name. maxLength: 40 minLength: 0 type: string metadata: additionalProperties: type: string description: Associates any additional metadata you provide with the cardholder. type: object middle_name: description: Cardholder's middle name. maxLength: 40 minLength: 0 type: string nationality: description: Cardholder's nationality. maxLength: 255 minLength: 0 type: string notes: description: Any additional information pertaining to the cardholder. maxLength: 255 minLength: 0 type: string parent_token: description: Unique identifier of the parent user or business resource. maxLength: 36 minLength: 1 type: string passport_expiration_date: description: Expiration date of the cardholder's passport. readOnly: true type: string passport_number: description: Cardholder's passport number. maxLength: 40 minLength: 0 type: string password: description: Password to the cardholder's user account on the Marqeta platform. maxLength: 255 minLength: 1 type: string phone: description: Cardholder's telephone number. maxLength: 255 minLength: 0 type: string postal_code: description: Postal code of the cardholder's address. maxLength: 10 minLength: 0 type: string ssn: description: Cardholder's Social Security Number (SSN). type: string state: description: State or province where the cardholder resides. maxLength: 2 minLength: 0 type: string status: description: Specifies the status of the cardholder on the Marqeta platform. enum: - UNVERIFIED - LIMITED - ACTIVE - SUSPENDED - CLOSED - TERMINATED type: string title: description: Professional title of the cardholder, such as Chief Comptroller. maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string uses_parent_account: default: false description: Indicates whether the child shares balances with the parent (`true`), or the child's balances are independent of the parent (`false`). type: boolean zip: description: United States ZIP code of the cardholder's address. maxLength: 10 minLength: 0 type: string required: - created_time - last_modified_time type: object card_personalization: description: Specifies personalized attributes to be added to the card. properties: carrier: $ref: '#/components/schemas/carrier' images: $ref: '#/components/schemas/images' perso_type: description: Specifies the type of card personalization. enum: - EMBOSS - LASER - FLAT type: string text: $ref: '#/components/schemas/text' required: - text type: object program_transfer_response: description: Contains information about a program transfer, which moves funds from an account holder's GPA to a program funding source. properties: amount: description: Amount of program transfer. type: number business_token: description: 'Unique identifier of the business account holder. Returned if `user_token` is not specified.' maxLength: 36 minLength: 1 type: string created_time: description: Date and time when the program transfer object was created, in UTC. format: date-time type: string currency_code: description: Three-digit ISO 4217 currency code. type: string fees: description: Contains attributes that define characteristics of one or more fees. items: $ref: '#/components/schemas/fee_detail' type: array jit_funding: $ref: '#/components/schemas/jit_funding_api' memo: description: Additional description of the program transfer. maxLength: 99 minLength: 1 type: string tags: description: Comma-delimited list of tags describing the program transfer. maxLength: 255 minLength: 1 type: string token: description: Unique identifier of the program transfer. maxLength: 36 minLength: 1 type: string transaction_token: description: Unique identifier of the transaction. type: string type_token: description: Unique identifier of the program transfer type. maxLength: 36 minLength: 1 type: string user_token: description: 'Unique identifier of the user account holder. Returned if `business_token` is not specified.' maxLength: 36 minLength: 1 type: string required: - amount - currency_code - transaction_token - type_token type: object jit_account_name_verification: description: 'Contains account name verification data used to make JIT Funding decisions from one of the following objects: * The `gateway` object, which contains account name verification data from your JIT Funding gateway. * The `issuer` object, which contains account name verification data from the Marqeta platform. * The `request` object, which contains account name verification data as it appears in a JIT Funding request.' properties: gateway: $ref: '#/components/schemas/account_name_verification_source' issuer: $ref: '#/components/schemas/account_name_verification_source' request: $ref: '#/components/schemas/ani_information' type: object business_metadata: description: Contains customer-provided information about the business that funded the transaction. properties: metadata: additionalProperties: type: string description: Associates customer-provided metadata with the business. type: object type: object withdrawal_request_model: properties: account_type: enum: - checking - savings - credit type: string amount: type: number card_acceptor: $ref: '#/components/schemas/card_acceptor_model' card_token: maxLength: 36 minLength: 1 type: string mid: maxLength: 50 minLength: 1 type: string pin: maxLength: 15 minLength: 1 type: string webhook: $ref: '#/components/schemas/webhook' required: - amount - card_token - mid type: object funding: description: Contains funding information for the transaction, including funding amount, type, and time. properties: amount: description: Amount of funds loaded into the GPA. type: number gateway_log: $ref: '#/components/schemas/gateway_log_model' source: $ref: '#/components/schemas/funding_source_model' source_address: $ref: '#/components/schemas/CardholderAddressResponse' required: - source type: object activation_actions: description: 'Defines actions to execute when the card is activated. The fields in this object are mutually exclusive.' properties: swap_digital_wallet_tokens_from_card_token: description: 'Moves all digital wallet tokens from the specified card to the new card. Not relevant when `reissue_pan_from_card_token` is set. Send a `GET` request to `/cards/user/{token}` to retrieve card tokens for a particular user.' maxLength: 36 minLength: 1 type: string terminate_reissued_source_card: default: true description: 'If you are reissuing a card, the source card is terminated by default. To prevent the source card from being terminated, set this field to `false`. Only relevant when `reissue_pan_from_card_token` is set.' type: boolean type: object auto_reload_model: description: 'Contains information about an auto reload. See <> for more information. Returned if an auto reload was executed.' properties: active: default: true description: 'Specifies whether the auto reload is active. Only one auto reload per level, per object, can be active.' type: boolean association: $ref: '#/components/schemas/auto_reload_association' currency_code: description: Three-digit link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 currency code, window="_blank"]. type: string funding_source_address_token: description: 'Unique identifier of the funding source address to use for this auto reload. If your funding source is an ACH account, then a `funding_source_address_token` is not required. If your funding source is a payment card, you must have at least one funding source address in order to create a GPA order. Send a `GET` request to `/fundingsources/addresses/user/{user_token}` to retrieve address tokens for a user. Send a `GET` request to `/fundingsources/addresses/business/{business_token}` to retrieve address tokens for a business.' maxLength: 36 minLength: 1 type: string funding_source_token: description: 'Unique identifier of the funding source to use for this auto reload. Send a `GET` request to `/fundingsources/user/{user_token}` to retrieve funding source tokens for a user. Send a `GET` request to `/fundingsources/business/{business_token}` to retrieve funding source tokens for a business.' maxLength: 36 minLength: 1 type: string order_scope: $ref: '#/components/schemas/order_scope' token: description: 'Unique identifier of the auto reload. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.' maxLength: 36 minLength: 1 type: string required: - currency_code - order_scope type: object program: description: Information about the program on the Marqeta platform. properties: long_code: description: The program long code on the Marqeta platform. type: string program_id: description: The program identifier on the Marqeta platform. type: string short_code: description: The program short code on the Marqeta platform. type: string required: - long_code - program_id - short_code type: object StrongCustomerAuthenticationModel: description: Strong Customer Authentication information for contactless transactions properties: acquirer_exemption: description: Acquirer exemption type for the transaction enum: - MERCHANT_INITIATED_TRANSACTION - TRANSACTION_RISK_ANALYSIS - RECURRING_PAYMENT - LOW_VALUE_PAYMENT - SCA_PERFORMED - SECURE_CORPORATE_PAYMENT - AUTHENTICATION_OUTAGE_EXCEPTION type: string issuer_exemption: description: Issuer exemption type for the transaction enum: - LOW_VALUE_PAYMENT type: string type: object gpa_returns: description: Contains information about a GPA unload order. properties: amount: description: Amount of funds returned to the funding source. type: number created_time: description: Date and time when the GPA unload order was created, in UTC. format: date-time type: string funding: $ref: '#/components/schemas/funding' funding_source_address_token: description: Identifies the funding source used for this order. type: string funding_source_token: description: Identifies the funding source used for this order. type: string jit_funding: $ref: '#/components/schemas/jit_funding_api' last_modified_time: description: Date and time when the GPA unload order was last modified, in UTC. format: date-time type: string memo: description: Additional descriptive text. type: string original_order_token: description: Identifies the original GPA order. type: string response: $ref: '#/components/schemas/response' state: description: Current status of the GPA unload order. type: string tags: description: Comma-delimited list of tags describing the GPA order. type: string token: description: Unique identifier of the GPA unload order. type: string transaction_token: description: Unique identifier of the transaction. type: string required: - amount - created_time - funding - funding_source_token - last_modified_time - response - state - token - transaction_token type: object transit: description: Contains merchant-provided, transit-related metadata related to the transaction. properties: transaction_type: description: Type of transit transaction. enum: - PRE_FUNDED - REAL_TIME_AUTHORIZED - POST_AUTHORIZED_AGGREGATED - AUTHORIZED_AGGREGATED_SPLIT_CLEARING - OTHER - DEBIT_RECOVERY - AGGREGATED_TRANSACTION - ACCOUNT_STATUS_INQUIRY type: string transportation_mode: description: Mode of transportation. enum: - BUS - TRAIN - WATER_BORNE_VEHICLE - TOLL - PARKING - TAXI - PARA_TRANSIT - SELF_DRIVE_VEHICLE - COACH - LOCOMOTIVE - POWERED_MOTOR_VEHICLE - TRAILER - INTER_CITY - CABLE_CAR type: string type: object settlement_data: description: Contains information from the card network about currency conversion at the time of settlement, including the original currency of the transaction, the amount of the transaction in the original currency, and the conversion rate. properties: amount: description: The settled amount. type: number conversion_rate: description: 'Returned when the transaction currency is different from the origination currency. Conversion rate between the origination currency and the settlement currency.' type: number currency_code: description: The ISO 4217 code of the currency used in the transaction. type: string type: object account_funding: description: 'Contains details about account funding transactions. Account funding transactions move money into a cardholder''s general purpose account (GPA).' properties: entry_device_type: enum: - OFF_THE_SHELF_MOBILE_CONSUMER type: string funding_source: description: Specifies the type of account from which the transaction was funded. enum: - CREDIT - DEBIT - PREPAID - DEPOSIT_ACCOUNT - CASH - MOBILE_MONEY_ACCOUNT - NON_VISA_CREDIT - CHECK - ACH type: string receiver_account_type: description: Specifies the type of account receiving the funding. enum: - OTHER - RTN_BANK_ACCOUNT - IBAN - CARD_ACCOUNT - EMAIL - PHONE_NUMBER - BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE - WALLET_ID - SOCIAL_NETWORK_ID type: string receiver_name: description: Specifies the name of the account holder receiving the funding. type: string reference_id: type: string screening_score: 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 no score was available.' type: string sender_account_number: description: Account number of the sender funding the transaction. type: string sender_address: description: Street address of the sender funding the transaction. type: string sender_city: description: City of the sender funding the transaction. type: string sender_country: description: Country of the sender funding the transaction. type: string sender_date_of_birth: type: string sender_name: description: Name of the sender funding the transaction. type: string sender_postal_code: type: string sender_state: description: State or province of the sender funding the transaction. type: string transaction_purpose: description: Describes the purpose of the account funding transaction. type: string transaction_type: description: Specifies the account funding transaction type. 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 type: string type: object fee_transfer_response: description: Contains information about a fee charge, including the amount, currency code, and user or business token. properties: business_token: description: Specifies the business account holder to which the fee applies. maxLength: 36 minLength: 1 type: string created_time: description: Date and time when the `fee_charge` object was created, in UTC. format: date-time type: string fees: description: Contains attributes that define characteristics of one or more fees. items: $ref: '#/components/schemas/fee_detail' type: array tags: description: 'Metadata about the fee charge. This field is returned if it exists in the resource.' maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the fee transfer. maxLength: 36 minLength: 1 type: string user_token: description: Specifies the user account holder to which the fee applies. maxLength: 36 minLength: 1 type: string required: - business_token - created_time - fees - token - user_token type: object jit_program_response: description: Contains the gateway's information about the JIT Funding transaction. properties: flex: $ref: '#/components/schemas/flex' jit_funding: $ref: '#/components/schemas/jit_funding_api' network_metadata: $ref: '#/components/schemas/network_metadata' required: - jit_funding type: object CurrencyBalance: properties: available_balance: type: number cached_balance: type: number credit_balance: type: number impacted_amount: type: number ledger_balance: type: number pending_credits: type: number type: object available: description: 'Specifies the available balances of the velocity controls associated with a user. This object is not returned if the velocity control window is `TRANSACTION`, because available balances do not apply to single-transaction velocity windows.' properties: amount: description: Total amount of spend remaining in the velocity control. exclusiveMinimum: false minimum: 0 type: number days_remaining: description: Number of days remaining in the velocity control time window. format: int32 type: integer uses: default: 0 description: Number of uses remaining in the velocity control. format: int32 type: integer required: - amount - uses type: object address_verification_source: description: Contains address verification data consisting of address data 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. properties: on_file: $ref: '#/components/schemas/avs_information' response: $ref: '#/components/schemas/response' type: object order_scope: description: Defines the balance threshold and reload amounts. properties: gpa: $ref: '#/components/schemas/gpa' type: object currency_conversion: description: Contains information about currency conversion. properties: network: $ref: '#/components/schemas/network' type: object cardholder_authentication_data: description: 'Contains authentication data for 3D Secure and digital wallet token transactions: * `electronic_commerce_indicator` – The level of verification performed. * `verification_result` – The result of the verification. * `verification_value_created_by` – The transaction participant who determined the verification result. * `three_ds_message_version` – The 3D Secure message version used for authentication. * `authentication_method` – The 3D Secure authentication method. * `authentication_status` – The 3D Secure authentication status. * `acquirer_exemption` – Indicates a 3D Secure authentication exemption from the acquirer. * `issuer_exemption` – Indicates a 3D Secure authentication exemption from the issuer. * `cavv_authentication_amount` – CAVV authentication amount. * `raw_cavv_data` – Raw CAVV data provided by the card network.' properties: acquirer_exemption: description: 'Indicates 3D Secure authentication exemptions from the acquirer. This array is returned if it is included in the transaction data from the card network.' items: type: string type: array authentication_method: description: Specifies the 3D Secure authentication method. type: string authentication_status: description: 'Specifies the status of the 3D Secure authentication: * `ATTEMPTED`: Indicates that 3D Secure authentication was requested and processed by the card network. * `DATA_SHARE_EXEMPTED`: Indicates that 3D Secure authentication was for information only and exempted. * `EXEMPTED`: Indicates that 3D Secure authentication was requested but the challenge was exempted. * `EXEMPTION_CLAIMED`: Indicates that 3D Secure authentication was exempted because acquirer transaction risk analysis (TRA) was already performed. * `SCA_EXEMPTION`: Indicates that 3D Secure authentication was exempted because strong customer authentication (SCA) was already performed. * `SUCCESSFUL`: Indicates that 3D Secure authentication was successful. * `SUCCESSFUL_NON_PAYMENT`: Indicates that 3D Secure non-payment authentication was successful. * `THREEDS_REQUESTER_DATA_SHARE_EXEMPTION`: Status is deprecated and will be removed from a future release of the Marqeta platform. After June 2023, use `DATA_SHARE_EXEMPTION` instead. * `THREEDS_REQUESTER_SCA_EXEMPTION`: Status is deprecated and will be removed in a June 2023 release of the Marqeta platform. After June 2023, use `SCA_EXEMPTION` instead. * `THREEDS_REQUESTER_TRA_EXEMPTION`: Status is deprecated and will be removed in a June 2023 release of the Marqeta platform. After June 2023, use `EXEMPTION_CLAIMED` instead. * `UNAVAILABLE`: ** For Visa transactions, this status indicates that 3D Secure authentication was requested, but Marqeta''s access control server (ACS) was not available. ** For Mastercard transactions, this status indicates that 3D Secure authentication was not available.' type: string cavv_authentication_amount: description: 'Authentication amount from the cardholder authentication verification value (CAVV) used to validate an authorization. This field is returned if it is included in the transaction data from the card network. To enable this field, contact your Marqeta representative.' type: string electronic_commerce_indicator: description: 'Status of the 3D Secure or digital wallet token transaction authentication attempt, as provided by a transaction participant. * `authentication_attempted`: Merchant attempted to authenticate, but either the issuer or the cardholder does not participate in 3D Secure or card tokenization. * `authentication_successful`: Cardholder authentication successful. * `no_authentication`: Non-authenticated e-commerce transaction.' type: string issuer_exemption: description: 'Indicates a 3D Secure authentication exemption from the issuer. This field is returned if it is included in the transaction data from the card network.' type: string raw_cavv_data: description: 'Raw cardholder authentication verification value provided by the card network. This field is returned if it is included in the transaction data from the card network. To enable this field, contact your Marqeta representative.' type: string three_ds_data_quality: type: string three_ds_message_version: description: Specifies the 3D Secure message version used for authentication. type: string three_ds_reference_id: description: The 3D Secure authentication indicator, as provided by the Mastercard card network. type: string verification_result: description: 'Result of cardholder authentication verification value (CAVV) or accountholder authentication value (AAV) verification performed by the card network. * `failed` * `not_present` * `not_provided` * `not_verified` * `not_verified_authentication_outage` * `verified` * `verified_amount_checked` * `verified_amount_greater_than_20_percent`: For Mastercard AAV verification, indicates that the original authentication amount and final authorization amount are mismatched, and that the final authorization amount exceeds the original authentication amount by more than 20%. This 20% margin falls outside Mastercard''s suggested tolerance for what a European cardholder might reasonably expect when the total transaction amount is not known in advance. * `verified_amount_less_than_20_percent`: For Mastercard AAV verification, indicates that the original authentication amount and final authorization amount are mismatched, and that the final authorization amount exceeds the original authentication amount by 20% or less. This 20% margin falls within Mastercard''s suggested tolerance for what a European cardholder might reasonably expect when the total transaction amount is not known in advance. * `not_verified_mac_key_validation_passed`: For Mastercard only. This field is present when the transaction passes MAC key validation but Dynamic Linking was not performed by the Mastercard card network due to system connectivity issues. * `not_verified_mac_key_validation_failed`: For Mastercard only. This field is present when the transaction fails MAC key validation and Dynamic Linking was not performed by the Mastercard card network due to system connectivity issues.' type: string verification_value_created_by: description: Transaction participant who determined the verification result. type: string type: object Authentication: description: Contains the cardholder's email address and password information. properties: email_verified: default: false description: Specifies whether the email address has been verified. type: boolean email_verified_time: description: Date and time when the email address was verified. format: date-time type: string last_password_update_channel: description: Specifies the channel through which the password was last changed. enum: - USER_CHANGE - USER_RESET type: string last_password_update_time: description: Date and time when the password was last changed. format: date-time type: string type: object images_carrier_return_window: description: Specifies a custom image to display in the return address window of the card carrier envelope. properties: name: description: Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. type: string type: object simulation_response_model: properties: raw_iso8583: additionalProperties: properties: {} type: object readOnly: true type: object transaction: $ref: '#/components/schemas/transaction_model' type: object vcn_data_model: properties: virtual_pan: description: Original virtual PAN type: string type: object flex: description: Contains information about a Flexible Credential transaction. properties: action: description: Indicates whether the Flexible Credential transaction object is actionable (`inquiry`) or merely informative (`advice`). enum: - inquiry - advice type: string eligible: description: Indicates whether or not the transaction is eligible for Flexible Credential transactions. type: string eligible_products: description: 'Specifies which of the payment instrument''s credentials is eligible for this transaction: * A value of `DEBIT` indicates the primary credential. * A value of `LOAN` indicates the secondary credential.' items: type: string type: array secondary_credential_identifier: description: Identifies the secondary credential used in the transaction, if applicable. type: string selected_product: description: Indicates the eligible product that was used in the transaction. type: string type: object balance_inquiry_request_model: properties: account_type: enum: - checking - savings - credit type: string card_acceptor: $ref: '#/components/schemas/card_acceptor_model' card_token: maxLength: 36 minLength: 1 type: string mid: maxLength: 50 minLength: 1 type: string network_fees: items: $ref: '#/components/schemas/network_fee_model' type: array pin: maxLength: 15 minLength: 1 type: string vcn_data: $ref: '#/components/schemas/vcn_data_model' webhook: $ref: '#/components/schemas/webhook' required: - account_type - card_acceptor - card_token - mid type: object gateway_log_model: description: Contains information from the JIT Funding gateway in response to a funding request. properties: duration: description: Length of time in milliseconds that the gateway took to respond to a funding request. format: int64 type: integer message: 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.' type: string order_number: description: Customer order number, same value as `transaction.token`. type: string response: $ref: '#/components/schemas/gateway_response' timed_out: default: false description: Whether the gateway sent a response (`true`) or timed out (`false`). type: boolean transaction_id: description: Customer-defined identifier for the transaction. type: string required: - message - order_number - transaction_id type: object address_verification_model: description: Contains address verification data consisting of address data 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. properties: on_file: $ref: '#/components/schemas/avs_information' request: $ref: '#/components/schemas/avs_information' response: $ref: '#/components/schemas/response' type: object network_metadata: description: 'Contains network-related metadata for the transaction, including details about the card program and the card product. Returned if provided by the card network' properties: account_identification_1: type: string incoming_response_code: description: 'Network response code, as provided by the card network. For example, Visa response code `59` indicates suspected fraud.' type: string message_reason_code: type: string network_funding_txn_type: description: Transaction type indicator provided by the card network for original credit and account funding transactions. type: string outgoing_response_code: description: 'Network response code, as provided by Marqeta. For example, Visa response code `59` indicates suspected fraud.' type: string product_id: description: 'Product identification value assigned by the card network to each card product. Can be used to track card-level activity by individual account number for premium card products.' type: string program_id: description: Program identification number used with `product_id` that identifies the programs associated with a card within a program registered by the issuer with the card network. type: string spend_qualifier: description: Indicates whether or not the base spend-assessment threshold defined by the card network has been met. type: string surcharge_free_atm_network: description: Name of the surcharge-free ATM network used to complete the transaction. type: string terminal_verification_results: type: string type: object text: description: Specifies personalized text that appears on the card. properties: name_line_1: $ref: '#/components/schemas/text_value' name_line_2: $ref: '#/components/schemas/text_value' name_line_3: $ref: '#/components/schemas/text_value' required: - name_line_1 type: object auth_request_model: properties: amount: type: number card_acceptor: $ref: '#/components/schemas/card_acceptor_model' card_options: $ref: '#/components/schemas/card_options' card_token: maxLength: 36 minLength: 1 type: string cash_back_amount: type: number is_pre_auth: default: false type: boolean mid: maxLength: 50 minLength: 1 type: string network_fees: items: $ref: '#/components/schemas/network_fee_model' type: array network_metadata: $ref: '#/components/schemas/network_metadata' pin: maxLength: 50 minLength: 1 type: string transaction_options: $ref: '#/components/schemas/transaction_options' vcn_data: $ref: '#/components/schemas/vcn_data_model' webhook: $ref: '#/components/schemas/webhook' required: - amount - card_token - mid type: object device: description: Contains information related to the device being provisioned. properties: device_id: description: Identity number of the device. type: string ip_address: description: Device's IP address. type: string language_code: description: Language the device is configured to use. type: string location: description: Geographic coordinates of the device. type: string name: description: Name of the device. type: string phone_number: description: Device's telephone number. type: string token: description: Unique identifier of the device object. type: string type: description: Type of device being provisioned. type: string type: object cardholder_balance: description: Returns general purpose account (GPA) balances for a user or business. properties: available_balance: 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.' type: number balances: additionalProperties: $ref: '#/components/schemas/cardholder_balance' description: Contains GPA balance information, organized by currency code. type: object cached_balance: description: Not currently in use. type: number credit_balance: description: Not currently in use. type: number currency_code: description: Three-digit ISO 4217 currency code. type: string impacted_amount: description: Balance change based on the amount of the transaction. type: number last_updated_time: description: Date and time when the resource was last updated, in UTC. format: date-time type: string ledger_balance: 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.' type: number pending_credits: description: ACH loads that have been accepted, but for which the funding time has not yet elapsed. type: number required: - available_balance - balances - credit_balance - currency_code - last_updated_time - ledger_balance - pending_credits type: object payment_facilitator_model: description: Information about the payment facilitator of an account funding or original credit transaction. properties: city: description: Payment facilitator's city. type: string country_code: description: Payment facilitator's country code. type: string postal_code: description: Payment facilitator's postal code. type: string state: description: Payment facilitator's state location. type: string street_address: description: Payment facilitator's street address. type: string type: object CardholderAddressResponse: description: Contains information about the billing address of the funding source. properties: active: default: false description: Whether the address is active. type: boolean address_1: description: Street address of the funding source. maxLength: 255 minLength: 0 type: string address_2: description: 'Additional address information for the funding source. This field is returned if it exists in the resource.' maxLength: 255 minLength: 0 type: string business_token: description: 'Unique identifier of the business account holder associated with the address. This field is returned if it exists in the resource.' maxLength: 36 minLength: 1 type: string city: description: City of the funding source. maxLength: 40 minLength: 0 type: string country: description: Country of the funding source. maxLength: 40 minLength: 1 type: string created_time: description: Date and time when the address was created, in UTC. format: date-time type: string first_name: description: First name of the account holder associated with the funding source. maxLength: 40 minLength: 0 type: string is_default_address: default: false description: Whether this address is the default address used by the funding source. type: boolean last_modified_time: 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 type: string last_name: description: Last name of the account holder associated with the funding source. maxLength: 40 minLength: 0 type: string phone: description: 'Phone number of the funding source. This field is returned if it exists in the resource.' maxLength: 255 minLength: 0 type: string postal_code: description: Postal code of the funding source. maxLength: 10 minLength: 0 type: string state: description: 'Two-character state, provincial, or territorial abbreviation. For the complete list, see <>.' maxLength: 2 minLength: 0 type: string token: description: Unique identifier of the `funding_source_address` object. maxLength: 36 minLength: 1 type: string user_token: description: 'Unique identifier of the user account holder associated with the address. This field is returned if it exists in the resource.' maxLength: 36 minLength: 1 type: string zip: description: United States ZIP code of the funding source. maxLength: 10 minLength: 0 type: string required: - address_1 - city - country - created_time - first_name - last_modified_time - last_name - postal_code - state - token - zip type: object digital_commerce_authentication_program: properties: billing_address_line_1: type: string billing_address_line_2: type: string billing_building_number: type: string billing_city: type: string billing_country_code: type: string billing_postal_code: type: string billing_street_name: type: string billing_subdivision_major: type: string billing_subdivision_minor: type: string email_address: type: string phone_number: type: string type: object orignalcredit_request_model: properties: amount: type: number card_acceptor: $ref: '#/components/schemas/card_acceptor_model' card_token: maxLength: 36 minLength: 1 type: string mid: maxLength: 50 minLength: 1 type: string screening_score: type: string sender_data: $ref: '#/components/schemas/original_credit_sender_data' transactionPurpose: type: string type: enum: - account_to_account - person_to_person - prepaid - wallet_transfer - money_transfer_by_bank - business_to_business - disbursement - government_disbursement - gambling_payout - loyalty - merchant_disbursement - online_gambling_payout - pension_disbursement - prepaid_loads - card_bill_payment - bill_payment - cash_claim - cash_in - cash_out - mobile_air_time_payment - money_transfer_by_merchant - face_to_face_merchant_payment - government_payment - payments_goods_services - purchase_repayment - visa_accept type: string webhook: $ref: '#/components/schemas/webhook' required: - amount - card_token - mid - type type: object ReversalModel: properties: amount: type: number find_original_window_days: format: int32 type: integer is_advice: default: false type: boolean network_fees: items: $ref: '#/components/schemas/network_fee_model' type: array original_transaction_token: maxLength: 36 minLength: 1 type: string vcn_data: $ref: '#/components/schemas/vcn_data_model' webhook: $ref: '#/components/schemas/webhook' required: - amount - original_transaction_token type: object carrier: description: Specifies attributes of the card carrier. properties: logo_file: description: Specifies an image to display on the card carrier. type: string logo_thumbnail_file: description: Specifies a thumbnail-sized rendering of the image specified in the `logo_file` field. type: string message_file: description: Specifies a text file containing a custom message to print on the card carrier. type: string message_line: description: Specifies a custom message that appears on the card carrier. type: string message_line_2: description: Specifies the second line of a custom message that appears on the card carrier. type: string template_id: description: Specifies the card carrier template to use. type: string type: object transaction_model: description: 'Transactions are represented by the `transaction` object. The Marqeta platform creates a separate `transaction` object for each transaction message received from the card network. The attributes of a given `transaction` object depend on the transaction type. This section documents all fields that might be included in a `transaction` object. // This schema is used by InfoDev to generate API reference documentation. // File location in GitHub is: openapi/transactions/schemas/transaction_model.yaml' properties: account_funding: $ref: '#/components/schemas/account_funding' account_name_verification: $ref: '#/components/schemas/account_name_verification_model' account_owner: $ref: '#/components/schemas/account_owner_model' accounts: items: $ref: '#/components/schemas/account_balance' type: array acquirer: $ref: '#/components/schemas/acquirer' acquirer_fee_amount: description: 'Indicates the amount of the acquirer fee. Account holders are sometimes charged an acquirer fee for card use at ATMs, fuel dispensers, and so on.' type: number acquirer_reference_data: description: 'Acquirer-assigned unique identifier of the transaction. Useful for settlement and reconciliation.' type: string acquirer_reference_id: description: 'Acquirer-assigned unique identifier of the transaction. Useful for settlement and reconciliation.' type: string acting_user_token: description: 'Unique identifier of the user who conducted the transaction. This might be a child user configured to share its parent''s account balance.' maxLength: 36 minLength: 0 type: string address_verification: $ref: '#/components/schemas/address_verification_model' advice_reason_code: description: Extended stand-in processing (STIP) reason code, as provided by the card network. type: string advice_reason_details: description: Extended stand-in processing (STIP) reason details, as provided by the card network. type: string amount: description: Amount of the transaction. type: number amount_to_be_released: description: 'Amount of original authorization to be released. This field appears in final clearing transactions where the clearing amount is lower than the authorization amount.' type: number anticipated_amount: description: 'Anticipated amount of the transaction, as provided by the card network. This field applies to anticipated amount verification transactions (AAVTs).' type: number approval_code: description: Unique identifier assigned to an authorization, printed on the receipt at point of sale. type: string atc_information: $ref: '#/components/schemas/ATCInformationModel' authorization_expiration: format: date-time type: string auto_reload: $ref: '#/components/schemas/auto_reload_model' bank_transfer_token: type: string batch_number: description: The batch number of the transaction. type: string billpay: $ref: '#/components/schemas/BillPayResponse' business: $ref: '#/components/schemas/business_metadata' business_token: description: Unique identifier of the business that owns the account that funded the transaction. maxLength: 36 minLength: 0 type: string card: $ref: '#/components/schemas/card_response' card_acceptor: $ref: '#/components/schemas/transaction_card_acceptor' card_holder_model: $ref: '#/components/schemas/user_card_holder_response' card_product_token: description: Unique identifier of the card product. maxLength: 36 minLength: 0 type: string card_security_code_verification: $ref: '#/components/schemas/card_security_code_verification' card_token: description: 'Unique identifier of the card. Useful when a single account holder has multiple cards.' maxLength: 36 minLength: 0 type: string cardholder_authentication_data: $ref: '#/components/schemas/cardholder_authentication_data' cardholder_impact: type: boolean cardholder_verification: $ref: '#/components/schemas/cardholder_verification' cash_back_amount: description: 'Amount of cash back requested by the cardholder during the transaction. Included in the total transaction amount.' type: number cashloads_direct: $ref: '#/components/schemas/CashloadsResponseModel' chargeback: $ref: '#/components/schemas/chargeback_response' clearing_record_sequence_number: description: A sequence number that identifies a specific clearing message among multiple clearing messages for an authorization. type: string created_time: 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 type: string currency_code: description: Currency type of the transaction. type: string currency_conversion: $ref: '#/components/schemas/currency_conversion' deferred_settlement_days: type: string digital_commerce_authentication_indicator: description: 'Visa Digital Commerce Authentication Program (VDCAP) indicator for U.S. domestic card-not-present transactions. Indicates the presence of key data elements, along with the eligible method used to share authentication data. * *02:* Visa Secure * *03:* Visa data only * *04:* Visa Payment Passkey with Visa Secure * *05:* Visa Payment Passkey with Visa Token Service * *06:* IDX 3rd party * *07:* Visa Token Service data only' type: string digital_commerce_authentication_program: $ref: '#/components/schemas/digital_commerce_authentication_program' digital_wallet_token: $ref: '#/components/schemas/digital_wallet_token' digital_wallet_token_transaction_service_provider_info: $ref: '#/components/schemas/digital_service_provider' direct_deposit: $ref: '#/components/schemas/DepositDepositResponse' dispute: $ref: '#/components/schemas/DisputeModel' duration: description: Duration of the transaction on Marqeta's servers, in milliseconds. format: int32 type: integer enhanced_data_token: description: The enhanced commercial card data token for the transaction. type: string estimated_authorization: description: 'Indicates an estimated authorization. An estimated authorization allows the merchant to obtain an approval for funds before the cardholder has finalized exactly what goods or services will be purchased.' type: boolean fee: $ref: '#/components/schemas/fee' fee_transfer: $ref: '#/components/schemas/fee_transfer_response' fees: 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' type: array fleet_data: $ref: '#/components/schemas/fleet_data' flex: $ref: '#/components/schemas/flex' fraud: $ref: '#/components/schemas/fraud_view' from_account: description: Specifies the funding account type. type: string from_account_token: type: string gpa: $ref: '#/components/schemas/cardholder_balance' gpa_order: $ref: '#/components/schemas/gpa_response' gpa_order_unload: $ref: '#/components/schemas/gpa_returns' identifier: description: Sequential identifier of the transaction. type: string incremental_authorization_transaction_tokens: description: An array of incremental authorization transaction tokens. items: type: string type: array installment_data: $ref: '#/components/schemas/installment_data' interchange_rate_descriptor: type: string is_final_clearing: description: 'Indicates the final clearing event for an authorization. If the final cleared amount is lower than the authorized amount, you must release the hold on the funds per the value in the `amount_to_be_released` field.' type: boolean is_preauthorization: default: false description: Indicates if the transaction is a pre-authorization. type: boolean isaIndicator: description: The international service assessment indicator indicates if an ISA fee is applicable to the transaction. enum: - MULTI_CURRENCY - SINGLE_CURRENCY - REBATE_CANCELLED - MULTI_CURRENCY_NON_US_COUNTRIES - SINGLE_CURRENCY_PAID_BY_ISSUER - NO_CHARGE_ASSESSED type: string issuer_interchange_amount: description: The amount of interchange charged by the card issuer. type: number issuer_payment_node: description: Unique identifier of the Marqeta platform server that received the transaction from the card network. type: string issuer_received_time: description: Date and time when the Marqeta platform received the transaction from the card network, in UTC. type: string local_transaction_date: description: 'Indicates the local time of the transaction at the card acceptor''s location. You can use this field to determine the correct time of the transaction when filing a dispute.' format: date-time type: string merchant: $ref: '#/components/schemas/merchant_response_model' merchant_initiated_original_trace_id: description: Unique network identification value formed by combining the 6- to 9-character Mastercard Banknet Reference Number and the 4-digit settlement date for recurring payments and other merchant-initiated transactions. type: string multi_clearing_sequence_count: description: 'If an authorization has multiple clearing transactions, this field displays their total number. For example, if an authorization has four clearing transactions, the sequence count is `04`.' type: string multi_clearing_sequence_number: description: 'If an authorization has multiple clearing transactions, this field displays the sequence number for the clearing transaction. For example, if this is the second clearing transaction of four, the sequence number is `02`.' type: string national_net_cpd_of_original: type: string network: description: Indicates which card network was used to complete the transactions. type: string network_metadata: $ref: '#/components/schemas/network_metadata' network_reference_id: description: 'Network-assigned unique identifier of the transaction. Useful for settlement and reconciliation.' type: string network_transaction_lifecycle_id: description: 'Transaction identifier, as provided by the card network. This identifier connects the original transaction to all subsequent activities throughout the transaction lifecycle.' type: string original_credit: $ref: '#/components/schemas/original_credit' original_network_transaction_lifecycle_id: type: string original_transaction_token: description: Unique identifier of the original transaction in a series of related transactions. type: string payment_facilitator: $ref: '#/components/schemas/payment_facilitator_model' peer_transfer: $ref: '#/components/schemas/peer_transfer_response' polarity: description: Indicates whether the transaction is credit or debit. enum: - CREDIT - DEBIT - PENDING_CREDIT - PENDING_DEBIT type: string pos: $ref: '#/components/schemas/pos' preceding_related_transaction_token: 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. For which transaction types are temporary or final, see <>.' type: string preceding_transaction: $ref: '#/components/schemas/preceding_transaction' program: $ref: '#/components/schemas/program' program_reserve_deposit_info: $ref: '#/components/schemas/program_reserve_transaction_response' program_transfer: $ref: '#/components/schemas/program_transfer_response' real_time_fee_group: $ref: '#/components/schemas/real_time_fee_group' reconciliation_cycle: type: string relay_resistance_protocol_result: type: string request_amount: description: Merchant-requested amount, including any fees. type: number response: $ref: '#/components/schemas/response' settlement_date: 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 type: string settlement_indicator: description: Indicates the settlement service used for the transaction. type: string standin_approved_by: description: 'Indicates which party approved a transaction: the card network using stand-in processing, or Marqeta using Commando Mode. Returned only when a transaction is approved.' type: string standin_by: description: 'Indicates which party approved a transaction: the card network using stand-in processing, or Marqeta using Commando Mode.' type: string standin_reason: description: Indicates why the card network handled a transaction requiring stand-in processing. type: string state: description: 'Current state of the transaction. For more information about the `state` field, see <>.' enum: - PENDING - CLEARED - COMPLETION - DECLINED - ERROR type: string store: $ref: '#/components/schemas/store_response_model' strong_customer_authentication: $ref: '#/components/schemas/StrongCustomerAuthenticationModel' sub_type: type: string subnetwork: description: 'Indicates which subnetwork was used to complete the transaction. Possible values include the following: * *VISANET* – Used for VisaNet signature-based transactions. * *VISANETDEBIT* – Used for VisaNet Debit PIN-based transaction. * *VISAINTERLINK* – Used for Visa Interlink PIN-based transactions. * *VISAPLUS* – Used for ATM withdrawals on Visa. * *MAESTRO* – Used for PIN-based transactions on Mastercard. * *CIRRUS* – Used for ATM withdrawals on Mastercard. * *MASTERCARDDEBIT* – Used for signature-based transactions on Mastercard. * *GATEWAY_JIT* – Used for Gateway JIT Funding transactions. * *MANAGED_JIT* – Used for Managed JIT Funding transactions or for transactions that occur while Commando Mode is enabled.' type: string to_account: description: Specifies the receiving account type. type: string token: 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`.' maxLength: 36 minLength: 1 readOnly: true type: string transaction_attributes: additionalProperties: type: string description: Additional transaction attributes. type: object transaction_metadata: $ref: '#/components/schemas/transaction_metadata' type: description: 'Transaction event type. For more information about the `type` field, see <>.' 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 - fee.charge.waived - fee.collection.debit - fee.collection.credit - 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.debit.adjustment - pindebit.quasi.cash - pindebit.refund - pindebit.refund.reversal - pindebit.reversal - pindebit.transfer - 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 - open.banking.fps.debit.hold - open.banking.fps.debit.clear - open.banking.fps.debit.hold.reverse - open.banking.fps.debit.clear.reverse - interest.posting.clear - interest.posting.clear.reverse - interest.posting.adjustment - unknown type: string user: $ref: '#/components/schemas/cardholder_metadata' user_token: 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. maxLength: 36 minLength: 0 type: string user_transaction_time: 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 type: string vdcap_qualified: type: boolean velocity_control_balances: additionalProperties: $ref: '#/components/schemas/available' type: object visa_pop_code: type: string required: - acting_user_token - amount - state - token - type title: Transaction object type: object account_name_verification_source: description: Contains account name verification data used to make JIT Funding decisions. properties: first_name: description: First or given name of the cardholder. type: string last_name: description: Last or family name of the cardholder. type: string middle_name: description: Middle name of the cardholder. type: string on_file: $ref: '#/components/schemas/ani_information' response: $ref: '#/components/schemas/response' type: object tag: properties: name: description: Name of the tag. type: string value: description: Value of the tag. type: string type: object wallet_provider_profile: description: Contains information held and provided by the digital wallet provider. properties: account: $ref: '#/components/schemas/account' device_score: description: Score from the device. type: string pan_source: description: Source from which the digital wallet provider obtained the card primary account number (PAN). type: string reason_code: description: 'Reason for the wallet provider''s provisioning decision. * *01* – Cardholder''s wallet account is too new relative to launch. * *02* – Cardholder''s wallet account is too new relative to provisioning request. * *03* – Cardholder''s wallet account/card pair is newer than date threshold. * *04* – Changes made to account data within the account threshold. * *05* – Suspicious transactions linked to this account. * *06* – Account has not had activity in the last year. * *07* – Suspended cards in the secure element. * *08* – Device was put in lost mode in the last seven days for longer than the duration threshold. * *09* – The number of provisioning attempts on this device in 24 hours exceeds threshold. * *0A* – There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours. * *0B* – The card provisioning attempt contains a distinct name in excess of the threshold. * *0C* – The device score is less than 3. * *0D* – The account score is less than 4. * *0E* – Device provisioning location outside of the cardholder''s wallet account home country. * *0G* – Suspect fraud.' type: string recommendation_reasons: description: Array of recommendation reasons from the digital wallet provider. items: type: string type: array risk_assessment: $ref: '#/components/schemas/risk_assessment' type: object financial_request_model: properties: amount: type: number card_acceptor: $ref: '#/components/schemas/card_acceptor_model' card_token: maxLength: 36 minLength: 1 type: string cash_back_amount: type: number is_pre_auth: default: false type: boolean mid: maxLength: 50 minLength: 1 type: string pin: maxLength: 15 minLength: 1 type: string transaction_options: $ref: '#/components/schemas/transaction_options' webhook: $ref: '#/components/schemas/webhook' required: - amount - card_acceptor - card_token - mid type: object avs_information: description: Contains address verification information. properties: postal_code: description: Postal code of the address. type: string street_address: description: Street name and number of the address. type: string zip: description: United States ZIP code of the address. type: string type: object digital_service_provider: properties: cvm_authentication_indicator: type: string cvm_authentication_method: type: string digital_service_indicator: type: string digital_service_provider_identifier_1: type: string digital_service_provider_identifier_2: type: string digital_service_provider_type_1: type: string digital_service_provider_type_2: type: string first_authentication_factor: type: string first_authentication_factor_name: enum: - NO_AUTHENTICATION - DEVICE_BOUND_PAYMENT - USERNAME_PASSWORD - PASSCODE_OR_PASSWORD - BEHAVIORAL_BIOMETRICS - BIOMETRIC_FINGERPRINT - BIOMETRIC_FACE - BIOMETRIC_IRIS - BIOMETRIC_VOICE - OTHER_BIOMETRICS - KNOWLEDGE_BASED - IN_APP_LOGIN - OTP_SMS - OTP_EMAIL - OTHER_OTP - OTHER type: string second_authentication_factor: type: string second_authentication_factor_name: enum: - NO_AUTHENTICATION - DEVICE_BOUND_PAYMENT - USERNAME_PASSWORD - PASSCODE_OR_PASSWORD - BEHAVIORAL_BIOMETRICS - BIOMETRIC_FINGERPRINT - BIOMETRIC_FACE - BIOMETRIC_IRIS - BIOMETRIC_VOICE - OTHER_BIOMETRICS - KNOWLEDGE_BASED - IN_APP_LOGIN - OTP_SMS - OTP_EMAIL - OTHER_OTP - OTHER type: string token_service_provider_id: type: string type: object digital_wallet_token_metadata: description: Contains additional information about the digital wallet token. properties: cardproduct_preferred_notification_language: description: 'Language specified in the `config.transaction_controls.notification_language` field of the card product: * *ces* – Czech * *deu* – German * *eng* – English * *fra* – French * *grc* – Greek * *ita* – Italian * *nld* – Dutch * *pol* – Polish * *por* – Portuguese * *rou* – Romanian * *spa* – Spanish * *swe* – Swedish By default, notifications are sent in English. The ISO maintains the link:https://www.iso.org/iso-3166-country-codes.html[full list of ISO 3166 two- and three-digit numeric country codes, window="_blank"].' type: string issuer_product_config_id: description: Unique identifier of the product configuration on the Marqeta platform. type: string type: object ClearingModel: properties: amount: type: number card_acceptor: $ref: '#/components/schemas/card_acceptor_model' force_post: default: false type: boolean is_refund: default: false type: boolean mid: maxLength: 50 minLength: 1 type: string network_fees: items: $ref: '#/components/schemas/network_fee_model' type: array original_transaction_token: maxLength: 36 minLength: 1 type: string vcn_data: $ref: '#/components/schemas/vcn_data_model' webhook: $ref: '#/components/schemas/webhook' required: - amount - original_transaction_token type: object account_name_verification_model: 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.' properties: on_file: $ref: '#/components/schemas/ani_information' request: $ref: '#/components/schemas/ani_information' request_type: enum: - SENDER - RECEIVER type: string response: $ref: '#/components/schemas/response' type: object issuer_fraud_view: description: Contains one or more fraud determinations by the card network that apply to either the transaction or the cardholder's account. properties: fraud_score_reasons: items: type: string type: array recommended_action: description: The action recommended based on the fraud score. type: string risk_level: description: The fraud rating, or level of risk associated with the transaction. type: string riskcontrol_tags: description: The RiskControl tags that were triggered by the transaction. items: $ref: '#/components/schemas/riskcontrol_tags' type: array rule_violations: description: The rules violated by the transaction. items: type: string type: array score: description: 'The risk score generated by RiskControl. This is either the Mastercard Decision Intelligence or Visa Advance Authorization transaction risk score.' format: int32 type: integer triggered_rules: description: Provides a list of rules triggered by a fraud event, along with the information on tags and rule characteristics. items: $ref: '#/components/schemas/triggered_rule' type: array type: object transaction_options: properties: additional_data: type: string card_expiration_date_yymm: type: string database_transaction_timeout: format: int32 type: integer encryption_key_id: type: string is_async: default: false type: boolean pre_auth_time_limit: type: string send_expiration_date: default: false type: boolean send_track_data: default: false type: boolean transaction_timeout_threshold_seconds: format: int64 type: integer transaction_token: type: string type: object riskcontrol_tags: description: The RiskControl tags that were triggered by the transaction. properties: rule_name: description: Name of the rule, as defined in the Real-Time Decisioning dashboard, that was triggered. type: string tag: description: Tag name defined in the rule definition in the Real-Time Decisioning dashboard. type: string values: description: Value associated with the tag. items: type: string type: array type: object jit_funding_api: description: 'Contains information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding.' properties: account_name_verification: $ref: '#/components/schemas/jit_account_name_verification' acting_user_token: description: 'User who conducted the transaction. Can be a child user configured to share its parent''s account balance.' maxLength: 36 minLength: 0 type: string address_verification: $ref: '#/components/schemas/jit_address_verification' amount: description: Requested amount of funding. exclusiveMinimum: false minimum: 0 type: number anticipated_amount_supported: type: boolean balances: additionalProperties: $ref: '#/components/schemas/cardholder_balance' description: Contains the GPA's balance details. type: object business_token: description: Holder of the business account that was funded. maxLength: 36 minLength: 0 type: string decline_reason: 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 - BLOCKED_BY_ISSUER - BLOCKED_BY_CARDHOLDER - BLOCKED_MERCHANT_BY_CARDHOLDER - INVALID_DRIVER_NUMBER - INVALID_VEHICLE_NUMBER type: string incremental_authorization_jit_funding_tokens: 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 type: array jit_account_name_verification: $ref: '#/components/schemas/jit_account_name_verification' memo: description: Additional information that describes the JIT Funding transaction. maxLength: 99 minLength: 0 type: string method: 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 type: string original_jit_funding_token: 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.' maxLength: 36 minLength: 0 type: string tags: description: Customer-defined tags related to the JIT Funding transaction. maxLength: 255 minLength: 0 type: string token: description: 'Existing JIT Funding token matching the `funding.gateway_log.transaction_id` field of the associated GPA order. *NOTE:* 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.' maxLength: 36 minLength: 0 type: string user_token: description: Holder of the user account that was funded. maxLength: 36 minLength: 0 type: string required: - amount - method - token - user_token type: object images_signature: description: Specifies an image of the cardholder's signature. properties: name: description: Specifies a PNG image of the cardholder's signature. type: string type: object network: description: Contains information from the card network about currency conversion, including the original currency of the transaction, the amount of the transaction in the original currency, and the conversion rate. properties: conversion_rate: description: 'Conversion rate between the origination currency and the settlement currency. Returned when the transaction currency is different from the origination currency.' type: number dynamic_currency_conversion: default: false description: Indicates whether currency conversion was performed dynamically at the point of sale. type: boolean original_amount: description: Amount of the transaction in the currency in which it originated. type: number original_currency_code: description: Currency type of the origination currency. type: string settlement_data: $ref: '#/components/schemas/settlement_data' type: object CashloadsResponseModel: properties: vendor_product_id: type: string type: object DisputeModel: description: Contains information about a disputed transaction. properties: case_management_identifier: description: The unique identifier of the dispute case. type: string reason: description: The reason for the dispute. type: string type: object ani_information: description: Contains account name verification data used to make JIT Funding decisions. properties: card_name: type: string first_name: description: First or given name of the cardholder. type: string last_name: description: Last or family name of the cardholder. type: string middle_name: description: Middle name of the cardholder. type: string type: object DirectDepositRequest: properties: account_number: type: string amount: type: number company_discretionary_data: maxLength: 20 minLength: 0 type: string company_entry_description: maxLength: 10 minLength: 0 type: string company_identification: maxLength: 10 minLength: 0 type: string company_name: maxLength: 16 minLength: 0 type: string earlyPayEligible: default: false type: boolean individual_identification_number: maxLength: 22 minLength: 0 type: string individual_name: maxLength: 35 minLength: 0 type: string settlement_date: format: date-time type: string standard_entry_class_code: maxLength: 3 minLength: 0 type: string token: maxLength: 36 minLength: 0 type: string type: enum: - CREDIT - DEBIT type: string required: - account_number - amount - settlement_date - type type: object original_credit_sender_data: properties: deferred_hold_by: enum: - absent - visa - originator - payment type: string fast_funds_enabled: type: boolean funding_source: enum: - credit - debit - prepaid - deposit_account - cash - mobile_money_payment - non_visa_credit - check - ach type: string sender_account_number: type: string sender_account_type: enum: - other - rtn_bank_account - iban - card_account - email - phone_number - bank_account_number_and_identification_code - wallet_id - social_network_id type: string sender_address: type: string sender_city: type: string sender_country: type: string sender_name: type: string sender_reference_number: type: string sender_state: type: string transaction_purpose: enum: - family_support - labor_transfers - travel - education - medical_treatment - emergency_need - savings - gifts - other - salary - lending - crypto_currency type: string unique_transaction_reference_number: maxLength: 17 minLength: 1 type: string visa_transaction_purpose: type: string required: - funding_source type: object acquirer: description: Contains information about the merchant's financial institution. properties: city: description: 'City of the merchant''s financial institution. This field appears only in account funding and original credit transactions.' type: string country_code: description: 'Country code of the merchant''s financial institution. This field appears only in account funding and original credit transactions.' type: string institution_country: description: Country code of the merchant's financial institution. type: string institution_id_code: description: Identifier code of the merchant's financial institution. type: string merchant_street_address: description: 'Street address of the merchant. This field appears only in account funding and original credit transactions.' type: string name: description: 'Name of the merchant''s financial institution. This field appears only in account funding and original credit transactions.' type: string network_international_id: description: International network identifier. type: string postal_code: description: 'Postal code of the merchant''s financial institution. This field appears only in account funding and original credit transactions.' type: string retrieval_reference_number: description: Retrieval reference number of the merchant's financial institution. type: string state: description: 'State where the merchant''s financial institution is located. This field appears only in account funding and original credit transactions.' type: string street_address: type: string system_trace_audit_number: description: System trace audit number of the merchant's financial institution. type: string type: object original_credit: 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. properties: deferred_hold_by: enum: - absent - visa - originator - payment type: string entry_device_type: enum: - OFF_THE_SHELF_MOBILE_CONSUMER type: string fast_funds_enabled: description: 'Indicates that Fast Funds are enabled for dual-message original credit transactions. If the value of this field is `true`, you must make the funds available to your cardholder within 30 minutes of the transaction.' type: boolean funding_source: description: Sender's account from which the OCT draws funds. enum: - CREDIT - DEBIT - PREPAID - DEPOSIT_ACCOUNT - CASH - MOBILE_MONEY_ACCOUNT - NON_VISA_CREDIT - CHECK - ACH type: string reference_id: type: string screening_score: 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.' type: string sender_account_number: type: string sender_account_type: 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 type: string sender_address: description: Sender's street address. type: string sender_city: description: Sender's city. type: string sender_country: description: Sender's country. type: string sender_date_of_birth: type: string sender_name: description: Full name of the sender. type: string sender_postal_code: type: string sender_state: description: Sender's state. type: string transaction_purpose: description: The purpose of the original credit transaction. type: string transaction_type: description: Type of original credit 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 - 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 - visa_accept type: string type: object securitySchemes: mqAppAndAccessToken: scheme: basic type: http