Note
The information provided on this page is confidential, intended only for Marqeta customers who have implemented RiskControl Real-Time Decisioning.
The information provided on this page is confidential, intended only for Marqeta customers who have implemented RiskControl Real-Time Decisioning.
eventType attribute. A derived type object typically corresponds to a bundle of information, such as an address or transaction. Attributes are subfields of the derived type. Most of the types are derived from the transactions object. For information on the transactions object, see Transactions.Every transaction processed by Real-Time Decisioning is classified as an event. For example, an authorization transaction in the authorization flow will be classified as a TRANSACTION_RT event.TRANSACTION_RT and TRANSACTION event types
The following sections describe the derived types forTRANSACTION_RT and TRANSACTION Real-Time Decisioning event types.TransactionModel
The following are attributes of theTransactionModel derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| token | string | Yes | A Marqeta-created UUID to uniquely identify this transaction. Note: For subsequent related transactions, this token value appears as the preceding_related_transaction_token.Schema: event.transaction.tokenExpected Values: 36 char max |
| user | object | No | Contains customer-provided information about the cardholder that performed the transaction. Null if business is not null.Schema: event.transaction.userExpected Values: See the UserCardHolderResponse object. |
| business | object | No | Contains customer-provided information about the business that funded the transaction. Null if user is not null.Schema: event.transaction.businessExpected Values: See the BusinessCardHolderResponse object. |
| acting_user | object | Yes | The user that initiated the transaction. Schema: event.transaction.acting_userExpected Values: See the UserCardHolderResponse object. |
| card | object | Yes | The card involved with the transaction. Schema: event.transaction.cardExpected Values: See the CardResponse object. |
| type | string | Yes | A Marqeta code defining the type of transaction. Schema: event.transaction.typeExpected Values: See Transaction types supported by Real-Time Decisioning. |
| status | string | Yes | The transaction status. Current state of the transaction. For more information about the Status field, see The transaction lifecycle. Schema: event.transaction.stateExpected Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL |
| created_time | datetime | Yes | Date and time when the Marqeta platform created the transaction entry, in UTC. Schema: event.transaction.created_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| user_transaction_time | datetime | Yes | Date and time when the user initiated the transaction, in UTC. Schema: event.transaction.user_transaction_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| settlement_date | string | No | Date and time when funds were moved for a transaction, in UTC. Schema: event.transaction.settlement_dateExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| request_amount | number | No | Amount used for clearing or settling transactions to compare to the original authorization amount. Schema: event.transaction.request_amountExpected Values: Format: 0.00 |
| amount | number | Yes | Amount of the transaction. Schema: event.transaction.amountExpected Values: Format: 0.00 |
| cash_back_amount | number | No | Amount of cash back requested by the cardholder during the transaction. Included in the total transaction amount. Schema: event.transaction.cash_back_amountExpected Values: Format: 0.00 |
| currency_conversion | object | Yes | Contains information about currency conversion. Schema: event.transaction.currency_conversionExpected Values: See the CurrencyConversion object. |
| currency_code | string | Yes | Currency type of the transaction. Schema: event.transaction.currency_codeExpected Values: Valid three-character ISO-4217 currency code. |
| approval_code | string | No | Unique identifier assigned to an authorization, printed on the receipt at point of sale. Schema: event.transaction.approval_codeExpected Values: 255 char max |
| preceding_related_transaction_token | string | No | Returned for final transaction types. Unique identifier of the preceding related transaction. Useful for identifying the transaction that preceded the current one. For which transaction types are temporary or final, see Transaction events in Event Types. Schema: event.transaction.preceding_related_transaction_tokenExpected Values: UUID |
| amount_to_be_released | number | No | Amount of original authorization to be released. This field appears in final clearing transactions where the clearing amount is lower than the authorization amount. Schema: event.transaction.amount_to_be_releasedExpected Values: Format: 0.00 |
| card_acceptor | object | Yes | Contains information about the merchant. Schema: event.transaction.card_acceptorExpected Values: See the TransactionCardAcceptor object. |
| gpa | object | No | General purpose account (GPA) balances for a user or business. Schema: event.transaction.gpaExpected Values: See the CardholderBalance object. |
| network | string | No | The card network handling the transaction. Schema: event.transaction.networkExpected Values: DISCOVER, MASTERCARD, PULSE, VISA, MARQETA |
| pos | object | No | Point-of-sale details associated with this transaction, including details on how the card was presented. May be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for v1 requests. Schema: event.transaction.posExpected Values: See the Pos object. |
| acquirer | object | Yes | Contains information about the merchant’s financial institution. Schema: event.transaction.acquirerExpected Values: See the Acquirer object. |
| polarity | string | No | Indicates whether the transaction is credit or debit. Schema: event.transaction.polarityExpected Values: CREDIT, DEBIT, PENDING_CREDIT, PENDING_DEBIT |
| address_verification_response_code | string | No | Four-digit code corresponding with the outcome of the attempted transaction type.card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:0000 - passed 0001 - did not pass Schema: event.transaction.address_verification_response_codeExpected Values: Four-digit code |
| card_security_code_verification | object | No | Contains information about a verification check performed on the card’s security code. Schema: event.transaction.card_security_code_verificationExpected Values: See the CardSecurityCodeVerification object. |
| network_reference_id | string | No | Network-assigned unique identifier of the transaction. Useful for settlement and reconciliation. Schema: event.transaction.network_reference_idExpected Values: 255 char max |
| acquirer_reference_id | string | No | Acquirer-assigned unique identifier of the transaction. Useful for settlement and reconciliation. Schema: event.transaction.acquirer_reference_idExpected Values: 255 char max |
| network_transaction_risk_score | integer | No | Network risk score associated with transaction. Schema: event.transaction.network_transaction_risk_scoreExpected Values: 0 - 99 |
| network_account_risk_score | integer | No | Network (Mastercard or Visa) risk score associated with account. Schema: event.transaction.network_account_risk_scoreExpected Values: 0 - 99 |
| is_force_post | boolean | No | True if transaction is a force post, which can happen in debit card transactions. Schema: event.transaction.is_force_postExpected Values: true, false |
| transaction_attributes | object | No | Additional transaction attributes. A key-value pair that allows passing of custom data from the Core API data attributes to the Fraud engine. Schema: event.transaction.transaction_attributesExpected Values: See the keyValuePair object. |
| transaction_metadata | object | No | Contains merchant-provided metadata related to the transaction, including details about lodging- and transit-related purchases. 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. Schema: event.transaction.transaction_metadataExpected Values: See the TransactionMetadata object. |
| declined_reason | string | No | Populated for TRANSACTION event types.Schema: event.transaction.declined_reasonExpected Values: See Transaction response codes. |
| digital_wallet_token | object | No | 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. Schema: event.transaction.digital_wallet_tokenExpected Values: See the DigitalWalletToken object. |
| address_verification | object | No | 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. Schema: event.transaction.address_verificationExpected Values: See the AddressVerification object. |
| cardholder_authentication_data | object | No | Contains 3-D Secure verification data. Schema: event.transaction.cardholder_authentication_dataExpected Values: See the CardholderAuthenticationData object. |
| subnetwork | string | No | The subnetwork that was used to complete the transaction. Schema: event.transaction.subnetworkExpected Values: VISANET, VISANETDEBIT, VISAINTERLINK, VISAPLUS, MAESTRO, CIRRUS, MASTERCARDDEBIT, GATEWAY_JIT, MANAGED_JIT |
| network_metadata | object | No | Contains network-related metadata for the transaction, including details about the card program and the card product. May be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for v1 requests. Schema: event.transaction.network_metadataExpected Values: See the NetworkMetadata object. |
UserCardHolderResponse
The following are attributes of theUserCardHolderResponse derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| token | string | Yes | The unique identifier of the cardholder. Schema: event.transaction.user.tokenevent.transaction.acting_user.tokenExpected Values: 1-36 chars |
| active | boolean | Yes | Specifies if the cardholder is in the ACTIVE state on the Marqeta platform.Schema: event.transaction.user.activeevent.transaction.acting_user.activeExpected Values: true, false |
| gender | string | No | Cardholder’s gender. Schema: event.transaction.user.genderevent.transaction.acting_user.genderExpected Values: M, F |
| first_name | string | No | Cardholder’s first name. Schema: event.transaction.user.first_nameevent.transaction.acting_user.first_nameExpected Values: 40 char max |
| middle_name | string | No | Cardholder’s middle name. Schema: event.transaction.user.middle_nameevent.transaction.acting_user.middle_nameExpected Values: 40 char max |
| last_name | string | No | Cardholder’s last name. Schema: event.transaction.user.last_nameevent.transaction.acting_user.last_nameExpected Values:40 char max |
| string | No | Email address of the cardholder. Schema: event.transaction.user.emailevent.transaction.acting_user.emailExpected Values: 1-255 chars | |
| address1 | string | No | Cardholder’s address. Schema: event.transaction.user.address1event.transaction.acting_user.address1Expected Values: 255 char max |
| address2 | string | No | Additional address information for the cardholder. Schema: event.transaction.user.address2event.transaction.acting_user.address2Expected Values: 255 char max |
| city | string | No | City where the cardholder resides. Schema: event.transaction.user.cityevent.transaction.acting_user.cityExpected Values: 40 char max |
| state | string | No | State in which the cardholder resides. Schema: event.transaction.user.stateevent.transaction.acting_user.stateExpected Values: 32 char max |
| zip | string | No | ZIP code of the cardholder’s address. Schema: event.transaction.user.zipExpected Values: 10 char max |
| postal_code | string | No | Postal code of the cardholder’s address. Schema: event.transaction.user.postal_codeExpected Values: 10 char max |
| country | string | No | Country in which the cardholder resides. Schema: event.transaction.user.countryExpected Values: 40 char max |
| phone | string | No | Cardholder’s telephone number (including area code), prepended by the + symbol and the 1- to 3-digit country calling code. Schema: event.transaction.user.phoneExpected Values: 255 char max Format: +15105551212 or +35552260859 |
| parent_token | string | No | Unique identifier of a parent user or business, if any. Schema: event.transaction.user.parent_tokenExpected Values: 1-36 chars |
| uses_parent_account | boolean | No | Indicates whether the child shares balances with the parent (true), or the child’s balances are independent of the parent (false).Schema: event.transaction.user.uses_parent_accountExpected Values: true, false |
| corporate_card_holder | boolean | No | Indicates if the card belongs to a business. Schema: event.transaction.user.corporate_card_holderExpected Values: true, false |
| nationality | string | No | Cardholder’s nationality. Schema: event.transaction.user.nationalityExpected Values: 255 char max |
| company | string | No | Company name. Schema: event.transaction.user.companyExpected Values: 255 char max |
| created_time | datetime | No | The date and time when the resource was created, in UTC. Schema: event.transaction.user.created_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| last_modified_time | datetime | Yes | The date and time when the resource was last updated, in UTC. Schema: event.transaction.user.last_modified_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| status | string | Yes | Specifies the status of the cardholder on the Marqeta platform. Schema: event.transaction.user.statusExpected Values: UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED |
| birth_date | date | No | Cardholder’s date of birth. Schema: event.transaction.user.birth_dateExpected Values: Format: yyyy-MM-dd |
| person_token | string | No | A unique UUID across all users and programs for the person associated with this user. Schema: event.transaction.user.person_tokenExpected Values: 36 char max |
BusinessCardHolderResponse
The following are attributes of theBusinessCardHolderResponse derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| token | string | Yes | Unique identifier of the business resource. Schema: event.transaction.business.tokenExpected Values: 1-36 chars |
| active | boolean | Yes | Specifies if the business is in the ACTIVE state on the Marqeta platform. Schema: event.transaction.business.activeExpected Values: true, false |
| created_time | datetime | No | Date and time when the business was created, in UTC. Schema: event.transaction.business.created_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| last_modified_time | datetime | Yes | Date and time when the business was last modified, in UTC. Schema: event.transaction.business.last_modified_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| status | string | Yes | Specifies the state of the business on the Marqeta platform. Schema: event.transaction.business.statusExpected Values: UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED |
| business_type | string | No | Indicates the type of business, for example B2B (business-to-business) or B2C (business-to-consumer). Schema: event.transaction.business.business_typeExpected Values: 255 char max |
| primary_contact | object | No | Describes the business’ primary contact person. Schema: event.transaction.business.primary_contactExpected Values: department, email, extension, fax, full_name, mobile, phone, title |
| phone | string | No | 10-digit telephone number of business. Schema: event.transaction.business.phoneExpected Values: Format: 510-555-1212 or 5105551212 |
| website | string | No | URL of the business’ website. Schema: event.transaction.business.websiteExpected Values: 255 char max |
| date_established | datetime | No | Date the business was established. Schema: event.transaction.business.date_establishedExpected Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| international_office_locations | string | No | Locations of the business’ offices outside the US. Schema: event.transaction.business.international_office_locationsExpected Values: 255 char max |
| office_location | address | No | Address associated with the business. Schema: Expected Values: address1, address2, city, country, postal_code, state, zip |
| metadata | array of strings | No | Metadata associated with the business. Schema: event.transaction.business.metadataExpected Values: Existing metadata object |
| business_name_dba | string | No | Fictitious or “doing business as” (DBA) name of the business. Schema: event.transaction.business.business_name_dbaExpected Values: Existing DBA name of the business |
| business_name_legal | string | No | Legal name of the business. Schema: event.transaction.business.business_name_legalExpected Values: Existing legal name of the business |
| ip_address | string | No | IP address of the business. Schema: event.transaction.business.ip_addressExpected Values: 39 char max |
| beneficial_owner1 | object | No | Contains information about the beneficial owner of the business, if applicable. Schema: event.transaction.business.beneficial_owner1Expected Values: first_name, getdob, home, last_name, middle_name, phone, title |
| beneficial_owner2 | string | No | Contains information about the beneficial owner of the business, if applicable. Schema: event.transaction.business.beneficial_owner2Expected Values: first_name, getdob, home, last_name, middle_name, phone, title |
| beneficial_owner3 | string | No | Contains information about the beneficial owner of the business, if applicable. Schema: event.transaction.business.beneficial_owner3Expected Values: first_name, getdob, home, last_name, middle_name, phone, title |
| beneficial_owner4 | string | No | Contains information about the beneficial owner of the business, if applicable. Schema: event.transaction.business.beneficial_owner4Expected Values: first_name, getdob, home, last_name, middle_name, phone, title |
CardResponse
The following are attributes of theCardResponse derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| created_time | datetime | No | The date and time, in UTC, when Marqeta created the card record. Schema: event.transaction.card.created_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| last_modified_time | datetime | Yes | The date and time of when the card record was last modified. Schema: event.transaction.card.last_modified_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| token | string | Yes | A Marqeta-created UUID to uniquely identify the card. Schema: event.transaction.card.tokenExpected Values: Existing card token |
| user_token | string | Yes | Unique identifier of the cardholder. Schema: event.transaction.card.user_tokenExpected Values: Existing user token |
| card_product | object | No | A Marqeta created UUID to uniquely identify the card product. Schema: Expected Values: See the CardProduct object. |
| status | string | Yes | Indicates the state of the card. Schema: event.transaction.card.statusExpected Values: ACTIVE, SUSPENDED, TERMINATED, UNSUPPORTED, UNACTIVATED, LIMITED |
| state_reason | string | No | Descriptive reason for why the card is in its current state. For example, “Card activated by cardholder”. Schema: event.transaction.card.state_reasonExpected Values: 255 char max |
| fulfillment_status | string | Yes | Card fulfillment status. Schema: event.transaction.card.fulfillment_statusExpected Values: ISSUED, ORDERED, REORDERED, REJECTED, SHIPPED, DELIVERED, DIGITALLY_PRESENTED. |
| type | string | No | The type of card. Schema: event.transaction.card.typeExpected Values: CREDIT or DEBIT |
| expiration | string | No | Expiration date in MMyy format. Schema: event.transaction.expirationExpected Values: Format: MMyy |
| bin | string | No | The first eight digits of the primary account number (PAN). Schema: event.transaction.card.binExpected Values: A valid card Buyer’s Identification Number |
CurrencyConversion
The following is an attribute of theCurrencyConversion derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| network | object | Yes | 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. Schema: event.transaction.currency_conversion.networkExpected Values: See the Network object. |
Network
The following are attributes of theNetwork derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| original_amount | number | Yes | Amount of the transaction in the currency in which it originated. Schema: event.transaction.network.original_amountExpected Values: Decimal amount. |
| conversion_rate | number | No | Returned when the transaction currency is different from the origination currency. Conversion rate between the origination currency and the settlement currency. Schema: event.transaction.network.conversion_rateExpected Values: Current conversion rate. A value of 0 or 1 indicates no conversion; the currencies are the same. |
| original_currency_code | string | Yes | The original currency code. Schema: event.transaction.network.original_currency_codeExpected Values: Valid three-digit ISO 4217 currency code |
TransactionCardAcceptor
The following are attributes of theTransactionCardAcceptor derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| mid | string | Yes | Merchant identifier. Schema: event.transaction.card_acceptor.midExpected Values: 255 char max |
| mcc | string | Yes | Merchant category code (MCC). Schema: event.transaction.card_acceptor.mccExpected Values: 255 char max |
| network_mid | string | No | The merchant identifier on the card network. Schema: event.transaction.card_acceptor.network_midExpected Values: 255 char max |
| mcc_groups | array of strings | No | An array of merchant category code groups. Schema: event.transaction.card_acceptor.mcc_groupsExpected Values: Valid array of one or more mcc_groups |
| name | string | No | Card acceptor’s name. Schema: event.transaction.card_acceptor.nameExpected Values: 50 char max |
| address | string | No | Card acceptor’s address. May be returned if the request uses Transaction Model v1 of the Marqeta Core API. Not returned for v2 requests. Schema: event.transaction.card_acceptor.addressExpected Values: 255 char max |
| city | string | No | Card acceptor’s city. Schema: event.transaction.card_acceptor.cityExpected Values: 40 char max |
| state | string | No | Two-character state, province, territorial, or federal abbreviation. For a complete list of valid state, provincial, territorial, and federal abbreviations, see Valid state, provincial, territorial, and federal abbreviations. Note: Non-US merchants may return more than 2 char for this field. Schema: event.transaction.card_acceptor.stateExpected Values: 2 char max |
| postal_code | string | No | Card acceptor’s postal code. Schema: event.transaction.card_acceptor.postal_codeExpected Values: 255 char max |
| country | string | No | Card acceptor’s country code. M ay be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for v1 requests. Schema: event.transaction.card_acceptor.country_codeExpected Values: Valid three-digit ISO 3166 country code |
| poi | object | No | Information about the terminal where the transaction occurred. Schema: event.transaction.card_acceptor.poiExpected Values: See the Terminal object. |
Terminal
The following are attributes of theTerminal derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| tid | string | Yes | Card acceptor or terminal identification number. Schema: event.transaction.card_acceptor.poi.tidExpected Values: 255 char max |
| partial_approval_capable | string | Yes | Whether the card acceptor or terminal is capable of partial approvals. Schema: event.transaction.card_acceptor.poi.partial_approval_capableExpected Values: true, false |
| cardholder_presence | string | No | Indicates if the cardholder is present. Schema: event.transaction.card_acceptor.poi.cardholder_presenceExpected Values: UNSPECIFIED, ATTENDED, UNATTENDED, NO_TERMINAL |
| card_presence | string | No | Whether the card was present during the transaction. Schema: event.transaction.card_acceptor.poi.card_presenceExpected Values: true, false |
| channel | string | No | Channel from which the transaction was originated. Schema: event.transaction.card_acceptor.poi.channelExpected Values: OTHER, ATM, ECOMMERCE, MAIL, PHONE, MOTO |
| pin_present | string | No | Indicates whether a PIN was presented during the transaction. Schema: event.transaction.card_acceptor.poi.pin_presentExpected Values: true, false |
| processing_type | string | No | The processing type. Schema: event.transaction.card_acceptor.poi.processing_typeExpected Values: |
CardholderBalance
The following are attributes of theCardholderBalance derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| currency_code | string | Yes | Currency code for the balance. Schema: event.transaction.gpa.currency_codeExpected Values: Three-digit ISO-4217 currency code. |
| available_balance | number | No | 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. Schema: event.transaction.gpa.available_balanceExpected Values: Format: 0.00 |
| credit_balance | number | No | Not currently in use. Schema: event.transaction.gpa.credit_balanceExpected Values: Not applicable |
| pending_credits | number | No | ACH loads that have been accepted, but for which the funding time has not yet elapsed. Schema: event.transaction.gpa.pending_creditsExpected Values: Format: 0.00 |
| impacted_amount | number | No | Balance change based on the amount of the transaction. Schema: event.transaction.gpa.impacted_amountExpected Values: Format: 0.00 |
| last_updated_time | datetime | No | Date and time when the resource was last updated, in UTC. Schema: event.transaction.gpa.last_updated_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
Pos
The following are attributes of thePos derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| pan_entry_mode | string | No | Method used for capturing the card primary account number (PAN) during the transaction. Schema: event.transaction.pos.pan_entry_modeExpected Values: UNKNOWN, MANUAL, MAG_STRIPE, MAG_STRIPE_CONTACTLESS, BAR_CODE, OCR, MICR, CHIP, CHIP_CONTACTLESS, CARD_ON_FILE, CHIP_FALLBACK, OTHER |
| pin_entry_mode | string | No | Whether the card acceptor or terminal can capture card personal identification numbers (PINs). Note: This field does not indicate whether a PIN was entered. Schema: event.transaction.pos.pin_entry_modeExpected Values: UNKNOWN, TRUE, FALSE, DEFECTIVE |
| terminal_id | string | No | Card acceptor or terminal identification number. Schema: event.transaction.pos.terminal_idExpected Values: 255 char max |
| terminal_attendance | string | No | Whether the card acceptor/terminal was attended. Schema: event.transaction.pos.terminal_attendanceExpected Values: UNSPECIFIED, ATTENDED, UNATTENDED, NO_TERMINAL |
| card_holder_presence | boolean | No | Whether the cardholder was present during the transaction. Schema: event.transaction.pos.card_holder_presenceExpected Values: true, false |
| cardholder_authentication_method | string | No | Method used to authenticate the cardholder. Schema: event.transaction.pos.cardholder_authentication_methodExpected Values: UNSPECIFIED_METHOD, NON_AUTHENTICATED, SIGNATURE, PIN, ID_VERIFIED |
| card_presence | boolean | No | Indicates whether the card was present during the transaction. Schema: event.transaction.pos.card_presenceExpected Values: true, false |
| pin_present | boolean | No | Indicates whether a PIN was presented during the transaction. Schema: event.transaction.pos.pin_presentExpected Values: true, false |
| terminal_type | string | No | Type of card acceptor/terminal. Schema: event.transaction.pos.terminal_typeExpected Values: AUTO_DISPENSER_WITH_PIN, SELF_SERVICE, LIMITED_AMOUNT, IN_FLIGHT, ECOMMERCE, TRANSPONDER |
| country_code | string | No | Country code of the card acceptor or terminal. Schema: event.transaction.pos.country_codeExpected Values: Valid three-digit ISO 3166 country code |
| zip | string | No | United States ZIP code of the card acceptor or terminal. Schema: event.transaction.pos.zipExpected Values: 10 char max |
| partial_approval_capable | boolean | No | Indicates whether the card acceptor or terminal is capable of partial approvals. Schema: event.transaction.pos.partial_approval_capableExpected Values: true, false |
| purchase_amount_only | boolean | No | Whether the card acceptor/terminal supports purchase-only approvals. Schema: event.transaction.pos.purchase_amount_onlyExpected Values: true , false` |
| is_recurring | boolean | No | Whether the transaction is recurring. Schema: event.transaction.pos.is_recurringExpected Values: true, false |
| is_installment | boolean | No | Whether the transaction is an installment payment. Schema: event.transaction.pos.is_installmentExpected Values: true, false |
Acquirer
The following are attributes of theAcquirer derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| institution_country | string | No | Country code of the merchant’s financial institution. Schema: event.transaction.acquirer.institution_countryExpected Values: Valid three-digit ISO 3166 country code |
| network_international_id | string | No | The international network identifier. Schema: event.transaction.acquirer.network_international_idExpected Values: 255 char max |
| institution_id_code | string | Yes | Identifier code of the merchant’s financial institution. Schema: event.transaction.acquirer.institution_id_codeExpected Values: 255 char max |
| retrieval_reference_number | string | Yes | Retrieval reference number of the merchant’s financial institution. Schema: event.transaction.acquirer.retrieval_reference_numberExpected Values: 255 char max |
| system_trace_audit_number | string | No | System trace audit number of the merchant’s financial institution. Schema: event.transaction.acquirer.system_trace_audit_numberExpected Values: 255 char max |
CardSecurityCodeVerification
The following are attributes of theCardSecurityCodeVerification derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| type | string | No | The card security code verification type: Schema: event.transaction.card_security_code_verification.typeExpected Values: CVV1, CVV2, ICVV |
| response_code | string | No | The Marqeta response code 0000 indicates success/verified; all other values indicate failure.Schema: event.transaction.card_security_code_verification.response_codeExpected Values: 0000 - passed 0001 - did not pass |
DigitalWalletToken
The following are attributes of theDigitalWalletToken derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| token | string | No | Unique identifier of the digital wallet token. Schema: event.transaction.digital_wallet_token.tokenExpected Values: Existing digital wallet token |
| card_token | string | No | Unique identifier of the card. Schema: event.transaction.digital_wallet_token.card_tokenExpected Values: Existing card token |
| state | string | No | State of the digital wallet token. See Transitioning token states. Schema: event.transaction.digital_wallet_token.stateExpected Values: REQUESTED, REQUEST_DECLINED, ACTIVE, SUSPENDED, TERMINATED |
| state_reason | string | No | Reason why the digital wallet token transitioned to its current state. Schema: event.transaction.digital_wallet_token.state_reasonExpected Values: 255 char max |
| fulfillment_status | string | No | Digital wallet token’s provisioning status. For fulfillment status descriptions, see Create digital wallet token transition. Schema: event.transaction.digital_wallet_token.fulfillment_statusExpected Values: DECISION_RED, DECISION_YELLOW, DECISION_GREEN, REJECTED, PROVISIONED |
| issuer_eligibility_decision | string | No | 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.Schema: event.transaction.digital_wallet_token.issuer_eligibility_decisionExpected Values: 0000, cardaccount.verified, card.suspicious, token.activation.verification.required, token.activation-request.decline, card.not.active, invalid.cid, card.expired, card.suspended, cardholder.not.active |
| created_time | datetime | No | Date and time when the digital wallet token object was created, in UTC. Schema: event.transaction.digital_wallet_token.created_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| last_modified_time | datetime | No | The date and time when the digital wallet was last modified. Schema: event.transaction.digital_wallet_token.last_modified_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| token_service_provider | object | No | Contains information held and provided by the token service provider (card network). Schema: event.transaction.digital_wallet_token.token_service_providerExpected Values: See the TokenServiceProvider object. |
| device | object | No | Contains information related to the device being provisioned. Schema: event.transaction.digital_wallet_token.deviceExpected Values: device_id, ip_address, language_code, location, name, phone_number, token, type |
| wallet_provider_profile | object | No | Contains information held and provided by the digital wallet provider. See the WalletProviderProfile object. Schema: event.transaction.digital_wallet_token.wallet_provider_profileExpected Values: account, device_score, pan_source, reason_code, recommendation_reasons, risk_assessment |
| address | object | No | Contains information about the digital wallet user’s address. Schema: event.transaction.digital_wallet_token.addressExpected Values: See the Address object. |
| user | object | No | Contains information about the cardholder. See the UserCardHolderResponse object. |
CardholderAuthenticationData
The following are attributes of theCardholderAuthenticationData derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| electronic_commerce_indicator | string | No | Status of the 3D Secure 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.authentication_successful: Cardholder authentication successful.no_authentication: Non-authenticated e-commerce transaction.Schema: event.transaction.cardholder_authentication_data.electronic_commerce_indicatorExpected Values: authentication_successful, authentication_attempted, no_authentication |
| verification_result | string | No | The result of the verification attempt, as provided by a transaction participant. Schema: event.transaction.cardholder_authentication_data.verification_resultExpected Values: verified, verified_amount_less_than_20_percent, verified_amount_greater_than_20_percent, failed, not_verified, not_present, not_provided, not_verified_authentication_outage |
| verification_value_created_by | string | No | Transaction participant who determined the verification result. Schema: event.transaction.cardholder_authentication_data.verification_value_created_byExpected Values: issuer_acs, issuer_attempts_server, network, network_attempts_server |
| three_ds_message_version | string | No | The 3D Secure message version used for authentication. Schema: event.transaction.cardholder_authentication_data.three_ds_message_versionExpected Values: 1.0.2, 2.1.0, 2.2.0 |
| authentication_method | string | No | The 3D Secure authentication method. Schema: event.transaction.cardholder_authentication_data.authentication_methodExpected Values: null, AUDIO_CALL, BEHAVIORAL_BIOMETRICS, BIOMETRIC_FACE, BIOMETRIC_FINGERPRINT, DECOUPLED, DELEGATED_TRUSTED_AUTHENTICATION, IN_APP_LOGIN, KNOWLEDGE_BASED, OTP_SMS, OTP_EMAIL, SECURE_PAYMENT_CONFM, VIDEO_CALL, VOICE_RECOGNITION, WEB_AUTHN, OTHER |
| authentication_status | string | No | The 3D Secure authentication status. Schema: event.transaction.cardholder_authentication_data.authentication_statusExpected Values: CANCELLED, FAILED, NOT_AUTHENTICATED, SUCCESS, SUCCESSFUL_NON_PAYMENT |
CardProduct
The following are attributes of theCardProduct derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| token | string | No | The card product token. Schema: event.transaction.card.card_product.tokenExpected Values: 1-36 chars |
| name | string | No | Name of the card product. Schema: event.transaction.card.card_product.nameExpected Values: 1-40 chars |
| active | boolean | No | Indicates whether the card product is active. Schema: event.transaction.card.card_product.nameExpected Values: true, false |
| start_date | string | No | Date when the card product becomes active. Schema: event.transaction.card.card_product.start_dateExpected Values: Format: yyyy-DD-mm |
| end_date | string | No | End date of the range over which the card product is active. Schema: event.transaction.card.card_product.end_dateExpected Values: Format: yyyy-DD-mm |
| config | object | No | Contains information about the configuration of the card product. Schema: event.transaction.card.card_product.configExpected Values: See the CardProductConfig object. |
PrimaryContact
The following are attributes of thePrimaryContact derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| full_name | string | No | Full name of the primary contact. Schema: businesses/primary_contact.full_nameExpected Values: 255 char max |
| title | string | No | Title of the primary contact. Schema: businesses/primary_contact.titleExpected Values: 255 char max |
| department | string | No | Business department of the primary contact. Schema: businesses/primary_contact.departmentExpected Values: 255 char max |
| phone | string | No | Phone number of the primary contact. Schema: businesses/primary_contact.full_nameExpected Values: 255 char max Format: 510-555-1212 or 5105551212 |
| extension | string | No | Phone extension of the primary contact. Schema: businesses/primary_contact.extensionExpected Values: 255 char max |
| fax | string | No | Fax number of the primary contact. Schema: businesses/primary_contact.faxExpected Values: 255 char max |
| mobile | string | No | Mobile phone number of the primary contact. Schema: businesses/primary_contact.mobileExpected Values: 255 char max Format: 510-555-1212 or 5105551212 |
| string | No | Email address of the primary contact. Schema: businesses/primary_contact.emailExpected Values: 255 char max |
BeneficialOwner
The following are attributes of theBeneficialOwner derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| first_name | string | No | First name of the beneficial owner. Schema: businesses/beneficial_owner1.first_nameExpected Values: 2 char min, 36 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| middle_name | string | No | Middle name of the beneficial owner. Schema: businesses/beneficial_owner1.middle_nameExpected Values: 255 char max |
| last_name | string | No | Last name of the beneficial owner. Schema: businesses/beneficial_owner1.last_nameExpected Values: 2 char min, 48 char max for KYC verification (US-based accounts only); 255 char max otherwise |
| title | string | No | Title of the beneficial owner. Schema: businesses/beneficial_owner1.titleExpected Values: 255 char max |
| home | object | No | Address associated with the business. Schema: businesses/beneficial_owner1.homeExpected Values: See Address. |
| phone | string | No | Ten-digit phone number of the beneficial owner. Schema: businesses/beneficial_owner1.phoneExpected Values: Format: 510-555-1212 or 5105551212 |
Address
The following are attributes of theAddress derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| address1 | string | No | Cardholder’s address. Schema: event.transaction.home.address1Expected Values: 255 char max |
| address2 | string | No | Additional address information for the cardholder. Schema: event.transaction.home.address2Expected Values: 255 char max |
| city | string | No | City where the cardholder resides. Schema: event.transaction.home.cityExpected Values: 40 char max |
| title | string | No | The beneficial owner’s title. Schema: event.transaction.home.titleExpected Values: 255 char max |
| state | string | No | State in which the cardholder resides. Schema: event.transaction.home.stateExpected Values: 2 char max |
| zip | string | No | United States ZIP code of the cardholder’s address. Schema: event.transaction.home.zipExpected Values: 10 char max |
| postal_code | string | No | Postal code of the cardholder’s address. Schema: event.transaction.home.postal_codeExpected Values: 10 char max |
| country | string | No | Country where the cardholder resides. Schema: event.transaction.home.countryExpected Values: 40 char max |
TokenServiceProvider
The following are attributes of theTokenServiceProvider derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| token_reference_id | string | No | Unique identifier of the digital wallet token within the card network. Schema: event.transaction.digital_wallet_token.token_service_provider.token_reference_idExpected Values: Existing Token Reference ID |
| pan_reference_id | string | No | Unique identifier of the digital wallet token primary account number (PAN) within the card network. Schema: event.transaction.digital_wallet_token.token_service_provider.pan_reference_idExpected Values: Existing PAN Reference ID |
| correlation_id | string | No | Unique value representing a tokenization request (Mastercard only). Schema: event.transaction.digital_wallet_token.token_service_provider.correlation_idExpected Values: Existing correlation identifier |
| token_requestor_id | string | No | Unique numerical identifier of the token requestor within the card network. These ID numbers map to token_requestor_name field values.Schema: event.transaction.digital_wallet_token.token_service_provider.token_requestor_idExpected Values: 11 char max Example Values Mastercard – 50110030273, 50120834693, 50139059239Visa – 40010030273, 40010075001, 40010075338, 40010075449, 40010075839, 40010043095 |
| token_requestor_name | string | No | 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. Schema: event.transaction.digital_wallet_token.token_service_provider.token_requestor_nameExpected Values: 255 char max |
| token_type | string | No | Type of the digital wallet token. Schema: event.transaction.digital_wallet_token.token_service_provider.token_typeExpected Values: MERCHANT_CARD_ON_FILE, DEVICE_SECURE_ELEMENT, DEVICE_CLOUD_BASED, ECOMMERCE_DIGITAL_WALLET |
| token_bin | string | No | The token BIN. Schema: event.transaction.digital_wallet_token.token_service_provider.token_binExpected Values: |
| token_expiration | string | No | Expiration date of the digital wallet token. Schema: event.transaction.digital_wallet_token.token_service_provider.token_expirationExpected Values: Format: MMyy |
| token_score | string | No | Token score assigned by the digital wallet. Schema: event.transaction.digital_wallet_token.token_service_provider.token_scoreExpected Values: 25 char max |
| token_assurance_level | string | No | (Mastercard only) Represents the confidence level in the digital wallet token. Schema: event.transaction.digital_wallet_token.token_service_provider.token_assurance_levelExpected Values: 0-99 |
| token_eligibility_decision | string | No | Digital wallet’s decision as to whether the digital wallet token should be provisioned. Schema: event.transaction.digital_wallet_token.token_service_provider.token_eligibility_decisionExpected Values: DECISION_RED, DECISION_YELLOW, DECISION_GREEN |
Device
The following are attributes of theDevice derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| token | string | No | Unique identifier of the device object. Schema: event.transaction.digital_wallet_token.device.tokenExpected Values: 36 char max |
| type | string | No | Type of device provisioned. Schema: event.transaction.digital_wallet_token.device.typeExpected Values: MOBILE_PHONE, WATCH, TABLET, MOBILE_PHONE_OR_TABLET, VEHICLE, APPLIANCE, LAPTOP, GAMING_DEVICE, UNKNOWN |
| language_code | string | No | Language the device is configured to use. Schema: event.transaction.digital_wallet_token.device.language_codeExpected Values: 50 char max |
| device_id | string | No | Identity number of the device. Schema: event.transaction.digital_wallet_token.device.device_idExpected Values: 20 char max |
| phone_number | string | No | Device’s telephone number. Schema: event.transaction.digital_wallet_token.device.phone_numberExpected Values: 50 char max |
| name | string | No | Name of the device. Schema: event.transaction.digital_wallet_token.device.nameExpected Values: 50 char max |
| location | string | No | Geographic coordinates of the device. Schema: event.transaction.digital_wallet_token.device.locationExpected Values: Latitude and longitude in DDD.DD/DDD.DD format.Note: Both the longitude and latitude are prefixed with either a + or - symbol, for example: +42.29/-71.07. |
| ip_address | string | No | Device’s IP address. Schema: event.transaction.digital_wallet_token.device.ip_addressExpected Values: 50 char max |
CardProductConfig
The following are attributes of theCardProductConfig derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| poi | object | No | Contains information that governs the point of interaction. Schema: event.transaction.card.card_product.config.poiExpected Values: See the Poi object. |
| transaction_controls | object | No | Contains transactional characteristics of card usage. Schema: event.transaction.card.card_product.config.transaction_controlsExpected Values: See the TransactionControls object. |
| jit_funding | string | No | Contains JIT Funding information. Schema: event.transaction.card.card_product.config.jit_fundingExpected Values: See the JitFunding object. |
WalletProviderProfile
The following are attributes of theWalletProviderProfile derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| device_score | string | No | Score from the digital wallet provider. Schema: event.transaction.digital_wallet_token.wallet_provider_profile.account.scoreExpected Values: 50 char max |
| pan_source | string | No | Source from which the digital wallet provider obtained the card primary account number (PAN). Schema: event.transaction.digital_wallet_token.wallet_provider_profile.pan_sourceExpected Values: KEY_ENTERED, ON_FILE, MOBILE_BANKING_APP |
| reason_code | string | No | 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. Schema: event.transaction.digital_wallet_token.wallet_provider_profile.reason_codeExpected Values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 0A, 0B, 0C, 0D, 0E, 0G |
| recommendation_reasons | array of strings | No | Array of recommendation reasons from the digital wallet provider. Schema: event.transaction.digital_wallet_token.wallet_provider_profile.recommendation_reasonsExpected Values: Valid array of one or more recommendation reasons |
Poi
The following are attributes of thePoi derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| other | string | No | Contains information about the other POI. Schema: event.transaction.card.card_product.config.poi.otherExpected Values: See the OtherPoi object. |
| ecommerce | boolean | No | Indicates if the POI is ecommerce. Schema: event.transaction.card.card_product.config.poi.ecommerceExpected Values: true, false |
| atm | boolean | No | Indicates if the POI is an ATM. Schema: event.transaction.card.card_product.config.poi.atmExpected Values: true, false |
OtherPoi
The following are attributes of theOtherPoi derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| allow | boolean | No | If set to true, card transactions at points of interaction other than e-commerce or ATMs are allowed. This group includes points of sale (POS).Schema: event.transaction.card.card_product.config.poi.other.allowExpected Values: true, false |
| card_presence_required | boolean | No | If set to true, cards of this card product type are required to be present during the transaction, such as in IVR scenarios.Schema: event.transaction.card.card_product.config.poi.other.card_presence_requiredExpected Values: true, false |
| cardholder_presence_required | boolean | No | If set to true, the cardholder is required to be present during the transaction, such as in a restaurant where the card is present but the cardholder might not be present when the card is swiped.Schema: event.transaction.card.card_product.config.poi.other.cardholder_presence_requiredExpected Values: true, false |
TransactionControls
The following are attributes of theTransactionControls derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| accepted_countries_token | string | No | Determines the list of countries in which a card can perform transactions. If set to accept_us_only, allows transactions only within the US.If set to decline_ofac_countries, allows international transactions except with countries that the Financial Action Task Force (FATF) and Office of Foreign Assets Control (OFAC) have identified as high risk.Users with the Admin role can create and update additional lists of accepted countries for transactions at the /acceptedcountries endpoint.Schema: cevent.transaction.card.card_product.config.transaction_control.accepted_countries_tokenExpected Values: accept_us_only, decline_ofac_countries, additional Admin-defined tokens |
| always_require_pin | boolean | No | If set to true, cards of this card product type require a personal identification number (PIN).Schema: event.transaction.card.card_product.config.transaction_control.always_require_pinExpected Values: true, false |
| allow_gpa_auth | boolean | No | If set to true, transactions can be authorized using GPA funds.Schema: event.transaction.card.card_product.config.transaction_control.allow_gpa_authExpected Values: true, false |
| require_card_not_present_card_security_code | boolean | No | A value of true indicates that if card_presence_required is true, the card’s security code is required.Schema: event.transaction.card.card_product.config.transaction_control.require_card_not_present_card_security_codeExpected Values: true, false |
| allow_mcc_group_authorization_controls | boolean | No | Indicates whether to allow MCC group authorization controls within the card product. The MCC group authorization_controls object allows you to automatically increase authorization holds and to specify authorization expiration times based on merchant type. By default, these settings apply to all cards in your program. You can, however, exempt cards associated with a particular card product by setting this field to false.Note: Partial authorizations are disallowed if this field is set to true.Schema: event.transaction.card.card_product.config.transaction_control.allow_mcc_group_authorization_controlsExpected Values: true, false |
| allow_first_pin_set_via_financial_transaction (deprecated) | boolean | No | Allows cardholders to define a personal identification number (PIN) as they complete their first PIN-debit transaction. Schema: event.transaction.card.card_product.config.transaction_control.allow_first_pin_set_via_financial_transactionExpected Values: true, false |
| ignore_card_suspended_state | boolean | No | Allows transactions to be approved even if the card’s state = SUSPENDED. When this field is set to true, the card behaves as if its state = ACTIVE.Schema: event.transaction.card.card_product.config.transaction_control.ignore_card_suspended_stateExpected Values: true, false |
| allow_chip_fallback | boolean | No | Indicates whether to allow transactions where a Europay Mastercard and Visa (EMV) chip-enabled card was processed using the magstripe as fallback. Schema: event.transaction.card.card_product.config.transaction_control.allow_chip_fallbackExpected Values: true, false |
| allow_network_load | boolean | No | Indicates whether card network loads are allowed. The associated card’s state must be ACTIVE or the load will be rejected.Schema: event.transaction.card.card_product.config.transaction_control.allow_network_loadExpected Values: true, false |
| allow_network_load_card_activation | boolean | No | Indicates whether card network loads are allowed. Sets the associated card’s state to ACTIVE if its current state is INACTIVE.Schema: event.transaction.card.card_product.config.transaction_control.allow_network_load_card_activationExpected Values: true, false |
| allow_quasi_cash | boolean | No | Indicates whether quasi-cash transactions are allowed. In a quasi-cash transaction, the cardholder purchases an item that can be directly converted to cash, such as traveler’s checks, money orders, casino chips, or lottery tickets. Schema: event.transaction.card.card_product.config.transaction_control.allow_quasi_cashExpected Values: true, false |
| enable_partial_auth_approval | boolean | No | Set to true to enable partial authorizations. When this setting is false and the requested authorization amount exceeds available funds, the transaction is declined. When this setting is true and the requested authorization amount exceeds available funds, the transaction is authorized for the amount of available funds.Schema: event.transaction.card.card_product.config.transaction_control.enable_partial_auth_approvalExpected Values: true, false |
| address_verification | object | No | Contains configuration options for AVS. Schema: event.transaction.card.card_product.config.transaction_control.address_verificationExpected Values: See the AvsControls object. |
| notification_language | string | No | Specifies the language for 3D Secure and digital wallet token notifications sent to cardholders under this card program. By default, notifications are sent in English (eng). You can also send notifications to your cardholders in Czech (ces), Dutch (nld), French (fra), German (deu), Greek (grc), Italian (ita), Polish (pol), Portuguese (prt), Romanian (rou), Spanish (spa), or Swedish (swe). If this field is blank, cardholders receive notifications in English.Schema: event.transaction.card.card_product.config.transaction_control.notification_languageExpected Values: ces, nld, fra, deu, grc, ita, pol, prt, rou, spa, swe |
| strong_customer_authentication_limits | object | No | Contains information about strong customer authentication (SCA) behavior for contactless point-of-sale (POS) and low-value payment (LVP) e-commerce transactions. Schema: cevent.transaction.card.card_product.config.transaction_control.strong_customer_authentication_limitsExpected Values: See the StrongCustomerAuthenticationLimits object. |
JitFunding
The following are attributes of theJitFunding derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| payment_funding_source | object | No | Enables and configures a payment funding source. Schema: event.transaction.card.card_product.config.jit_funding.payment_funding_sourceExpected Values: See the JitFundingPaymentcardFundingSource object. |
| programgateway_funding_source | object | No | Enables and configures a program gateway funding source. Schema: event.transaction.card.card_product.config.jit_funding.programgateway_funding_sourceExpected Values: See the JitFundingProgramgatewayFundingSource object. |
| program_funding_source | object | No | Enables and configures a program funding source. Schema: event.transaction.card.card_product.config.jit_funding.program_funding_sourceExpected Values: See the JitFundingProgramFundingSource object. |
AvsControls
The following are attributes of theAvsControls derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| av_messages | object | No | Contains verification options for account verification messages. These are $0 messages typically used to store cards on file at a merchant. Schema: event.transaction.card.card_product.config.transaction_control.address_verification.av_messagesExpected Values: See the AvsControlOptions object. |
| auth_messages | object | No | Contains verification options for authorization messages. These messages pertain to actual purchases and are for amounts greater than $0. Schema: event.transaction.card.card_product.config.transaction_control.address_verification.auth_messagesExpected Values: One or more verification options. See the AvsControlOptions object. |
AvsControlOptions
The following are attributes of theAvsControlOptions derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| validate | boolean | No | Indicates whether or not to require validation of account verification or authorization messages. Schema: event.transaction.card.card_product.config.transaction_control.address_verification.av_messages.validateExpected Values: |
| decline_on_address_number_mismatch | boolean | No | Indicates whether or not to decline account verification or authorization messages whose address number does not match the address number on file. Schema: event.transaction.card.card_product.config.transaction_control.address_verification.av_messages.decline_on_address_number_mismatchExpected Values: |
| decline_on_postal_code_mismatch | boolean | No | Indicates whether or not to decline account verification or authorization messages whose postal code does not match the postal code on file. Schema: Expected Values: |
StrongCustomerAuthenticationLimits
The following are attributes of theStrongCustomerAuthenticationLimits derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| sca_contactless_transaction_limit | string | No | Specifies the maximum allowable amount for a single contactless point-of-sale (POS) transaction, above which the cardholder receives a strong customer authentication (SCA) challenge. A value of 0 in this field means that the amount of any single contactless POS transaction performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Schema: event.transaction.card.card_product.config.transaction_control.sca_contactless_transaction_limitExpected Values: Format: 0.00 |
| sca_contactless_cumulative_amount_limit | string | No | Specifies the cumulative limit of transactions the cardholder can perform before receiving an SCA challenge. A value of 0 in this field means that the cumulative amount spent in contactless POS transactions performed by the cardholder does not impact the decision of whether or not an SCA challenge is served.Schema: event.transaction.card.card_product.config.transaction_control.sca_contactless_cumulative_amount_limitExpected Values: Format: 0.00 |
| sca_contactless_transactions_count_limit | string | No | Specifies the number of contactless POS transactions the cardholder can perform before receiving an SCA challenge. A value of 0 in this field means that the number of contactless POS transactions performed by the cardholder does not impact the decision of whether or not an SCA challenge is served.Schema: event.transaction.card.card_product.config.transaction_control.sca_contactless_transactions_count_limitExpected Values: Any integer, such as 5. |
| sca_contactless_transactions_currency | string | No | Specifies the currency type for contactless POS transactions. This field is required if either the sca_contactless_transaction_limit field or the sca_contactless_cumulative_amount_limit field in this object contains a value, even if that value is 0.Schema: event.transaction.card.card_product.config.transaction_control.sca_contactless_transactions_currencyExpected Values: Valid three-digit ISO 4217 currency type, such as EUR. |
| sca_lvp_transaction_limit | string | No | Specifies the maximum allowable amount for a single low-value payment (LVP) e-commerce transaction, above which the cardholder receives a strong customer authentication (SCA) challenge. If the field is blank, the amount of any single LVP e-commerce transaction performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Schema: cevent.transaction.card.card_product.config.transaction_control.sca_lvp_transaction_limitExpected Values: Format: 0.00 |
| sca_lvp_transactions_count_limit | string | No | Specifies the number of LVP e-commerce transactions the cardholder can perform before receiving an SCA challenge. If the field is blank, the total number of LVP e-commerce transactions performed by the cardholder does not impact the decision of whether or not an SCA challenge is served. Schema: cevent.transaction.card.card_product.config.transaction_control.sca_lvp_transactions_count_limitExpected Values: An integer, such as 5. |
| sca_lvp_transactions_currency | string | No | Specifies the currency type for LVP e-commerce transaction limits. This field is required if any one of the sca_lvp_transaction_limit, sca_lvp_cumulative_amount_limit, or sca_lvp_transactions_count_limit fields in this object contains a value, even if that value is 0.Schema: event.transaction.card.card_product.config.transaction_control.sca_lvp_transactions_currencyExpected Values: Valid three-digit ISO 4217 currency type, such as EUR. |
JitFundingPaymentcardFundingSource
The following are attributes of theJitFundingPaymentcardFundingSource derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| enabled | boolean | No | Specifies whether JIT Funding is enabled or disabled for the program gateway funding source. A value of true indicates that the program gateway funding source is enabled and will be debited when swipes occur. Schema: cardproducts/config.jit_funding.paymentcard_funding_source.enabledExpected Values: true, false |
| refunds_destination | string | No | Specifies the return destination for refunds in the case of a transaction reversal. PROGRAM_FUNDING_SOURCE returns funds to the program funding source. GPA returns the funds to the user’s GPA.Schema: cardproducts/config.jit_funding.program_funding_source.refunds_destinationExpected Values: GATEWAY, GPA, WATERFALL |
JitFundingProgramgatewayFundingSource
The following are attributes of theJitFundingProgramgatewayFundingSource derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| enabled | boolean | No | Specifies whether JIT Funding is enabled or disabled for the program gateway funding source. A value of true indicates that the program gateway funding source is enabled and will be debited when swipes occur.Schema: cardproducts/config.jit_funding.programgateway_funding_source.enabledExpected Values: true, false |
| funding_source_token | string | No | Unique identifier of the already existing funding source. Required if JIT Funding is enabled. Schema: cardproducts/config.jit_funding.programgateway_funding_source.funding_source_tokenExpected Values: 36 char max |
| refunds_destination | string | No | Specifies the return destination for refunds in the case of a transaction reversal. In most cases, you should set the value to GATEWAY, which returns funds to the program gateway funding source. Setting to GPA returns the funds to the user’s GPA, which creates a positive account balance and introduces the potential of a transaction being authorized without a JIT Funding request being sent to the gateway.Schema: cardproducts/config.jit_funding.programgateway_funding_source.refunds_destinationExpected Values: GATEWAY, GPA, WATERFALL |
| always_fund | boolean | No | If set to true, this card product is always funded from this program gateway funding source.Schema: cardproducts/config.jit_funding.programgateway_funding_source.always_fundExpected Values: true, false |
JitFundingProgramFundingSource
The following are attributes of theJitFundingProgramFundingSource derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| enabled | boolean | No | Specifies whether JIT Funding is enabled or disabled for the program funding source. A value of true indicates that the program funding source is enabled and will be debited when swipes occur.Schema: cardproducts/config.jit_funding.program_funding_source.enabledExpected Values: true, false |
| refunds_destination | string | No | Specifies the return destination for refunds in the case of a transaction reversal. PROGRAM_FUNDING_SOURCE returns funds to the program funding source. GPA returns the funds to the user’s GPA.Schema: cardproducts/config.jit_funding.program_funding_source.refunds_destinationExpected Values: GATEWAY, GPA, WATERFALL |
AddressVerification
The following are attributes of theAddressVerification derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| name | string | No | Name of the addressee. Schema: event.transaction.address_verification.nameExpected Values: |
| street_address | string | No | Street name and number of the address. Schema: event.transaction.address_verification.on_file.street_addressExpected Values: 40 char max |
| zip | string | No | United States ZIP code of the address. Schema: event.transaction.address_verification.on_file.zipExpected Values: 10 char max |
| postal_code | string | No | Postal code of the address. Schema: event.transaction.address_verification.on_file.postal_codeExpected Values: 10 char max |
NetworkMetadata
The following are attributes of theNetworkMetadata derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| product_id | string | No | 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. Schema: event.transaction.network_metadata.product_idExpected Values: AMERICAN_EXPRESS, DINERS, DISCOVER, FLEXIBLE_RATE_B2B_VIRTUAL_PROGRAM, JCB, MASTERCARD, PRIVATE_LABEL, PRIVATE_LABEL_BASIC, PRIVATE_LABEL_ENHANCED, PRIVATE_LABEL_PREMIUM, PRIVATE_LABEL_SPECIALIZED, PRIVATE_LABEL_STANDARD, PROPRIETARY, PROPRIETARY_ATM, V_PAY, VISA_B2B_VIRTUAL_PAYMENTS``VISA_BUSINESS, VISA_BUSINESS_ENHANCED/VISA_PLATINUM_BUSINESS, VISA_BUSINESS_REWARDS, VISA_CLASSIC, VISA_COMMERCIAL_AGRICULTURE, VISA_COMMERCIAL_MARKETPLACE, VISA_COMMERCIAL_TRANSPORT, VISA_CORPORATE_T&E, VISA_ELECTRON, VISA_FLEXIBLE_CREDENTIAL, VISA_GOLD, VISA_GOVERNMENT_CORPORATE_T&E, VISA_GOVERNMENT_PURCHASING, VISA_GOVERNMENT_PURCHASING_WITH_FLEET, VISA_HEALTHCARE, VISA_INFINITE, VISA_INFINITE_BUSINESS, VISA_INFINITE_PRIVILEGE, VISA_PLATINUM, VISA_PURCHASING, VISA_PURCHASING_WITH_FLEET/VISA_FLEET_(CANADA_ONLY), VISA_REWARDS, VISA_SELECT, VISA_SIGNATURE, VISA_SIGNATURE_BUSINESS, VISA_SIGNATURE_PREFERRED, VISA_TRADITIONAL, VISA_TRADITIONAL_REWARDS, VISA_TRAVELMONEY, VISA_ULTRA_HIGH_NET_WORTH_(UHNW) |
| program_id | string | No | 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.Schema: event.transaction.network_metadata.program_idExpected Values: 255 char max |
| spend_qualifier | string | No | Indicates whether or not the base spend-assessment threshold defined by the card network has been met. Schema: event.transaction.network_metadata.spend_qualifierExpected Values: 255 char max |
| surcharge_free_atm_network | string | No | Name of the surcharge-free ATM network used to complete the transaction. Schema: event.transaction.network_metadata.surcharge_free_atm_networkExpected Values: AllPoint, MoneyPass, MoneyPass Pulse Select |
TransactionMetadata
The following are attributes of theTransactionMetadata derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| transaction_category | string | No | Industry for which the transaction was originated. Schema: event.transaction.transaction_metadata.cross_border_transactionExpected Values: RETAIL_SALE, BILL_PAY, HOTEL, HEALTH_CARE, RESTAURANT, AUTO_RETAIL, AIRLINE, PAYMENT, HOSPITALIZATION_COLLEGE, PHONE_MAIL_ECOMMERCE, ATM, TRANSIT |
| payment_channel | string | No | Channel from which the transaction originated. Schema: event.transaction.transaction_metadata.payment_channelExpected Values: OTHER, ATM, ECOMMERCE, MAIL, PHONE, MOTO |
| cross_border_transaction | boolean | No | Whether the transaction is cross-border, such as when the merchant and the cardholder are located in two different countries. Schema: event.transaction.transaction_metadata.cross_border_transactionExpected Values: true, false |
| authorization_life_cycle | string | No | Number of days the pre-authorization is in effect. Schema: event.transaction.transaction_metadata.authorization_life_cycleExpected Values: Any integer |
| is_lodging_auto_rental | boolean | No | Whether the transaction is a lodging or vehicle rental. Schema: event.transaction.transaction_metadata.is_lodging_auto_rentalExpected Values: true, false |
| lodging_auto_rental_start_date | string | No | Date and time when the lodging check-in or vehicle rental began. Schema: event.transaction.transaction_metadata.lodging_auto_rental_start_dateExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| transit | string | No | Contains merchant-provided, transit-related metadata related to the transaction. Schema: event.transaction.transaction_metadata.transitExpected Values: See the Transit object. |
| airline | string | No | Contains information about airline-related transactions. Schema: event.transaction.transaction_metadata.airlineExpected Values: See the Airline object. |
| moto_indicator | string | No | Indicates the type of mail or telephone order transaction. Schema: event.transaction.transaction_metadata.moto_indicatorExpected Values: UNKNOWN, MANUAL, RECURRING, INSTALLMENT, OTHERS |
Transit
The following are attributes of theTransit derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| transaction_type | string | No | Type of transit transaction. Schema: event.transaction.transaction_metadata.transaction_typeExpected Values: PRE_FUNDED, REAL_TIME_AUTHORIZED, POST_AUTHORIZED_AGGREGATED, AUTHORIZED_AGGREGATED_SPLIT_CLEARING, DEBIT_RECOVERY, OTHER |
| transportation_mode | string | No | Mode of transportation. Schema: event.transaction.transaction_metadata.transportation_modeExpected Values: BUS, TRAIN, WATER_BORNE_VEHICLE, TOLL, PARKING, TAXI, PARA_TRANSIT, SELF_DRIVE_VEHICLE, COACH, LOCOMOTIVE, POWERED_MOTOR_VEHICLE, TRAILER, INTER_CITY, CABLE_CAR |
Airline
The following are attributes of theAirline derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| passenger_name | string | No | The name of the passenger. Schema: event.transaction.transaction_metadata.airline.passenger_nameExpected Values: 255 char max |
| depart_date | string | No | The date and time of departure. Schema: event.transaction.ttransaction_metadata.airline.depart_dateExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| origination_city | string | No | The city where the flight originates. Schema: event.transaction.transaction_metadata.airline.origination_cityExpected Values: 255 char max |
CARD_FRAUD event types
The following section describes the schemas forCARD_FRAUD Real-Time Decsioning event types.CardFraud
The following are attributes of theCardFraud derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| token | string | Yes | A Marqeta-created UUID to uniquely identify this fraud event. Schema: event.fraud.transaction.tokenExpected Values: 36 char max |
| transaction | object | Yes | The transaction associated with the fraud event. Schema: event.fraud.transactionExpected Values: See the TransactionModel object. |
| is_fraud | boolean | No | Indicates if fraud is suspected in the transaction. Schema: event.fraud.is_fraudExpected Values: true, false |
| status | string | Yes | The fraud status of the transaction. Schema: event.fraud.statusExpected Values: CONFIRMED, DISPUTED |
| actor | string | No | The actor for this transaction. Schema: event.fraud.actorExpected Values: UNKNOWN, THIRD_PARTY_FRAUD, CARD_USER_FRAUD |
| created_time | datetime | No | The date and time when Marqeta created this chargeback event. Schema: event.fraud.transaction.created_timeExpected Values: Format: yyyy-MM-ddThh:mm:ssZ |
| amount | number | No | The amount of the fraud event. Schema: event.fraud.transaction.amountExpected Values: Format: 0.00 |
| source | string | No | The source of the fraud event:API – Marqeta Customer facing APIREVIEW_MANAGER – Marqeta Review ManagerNETWORK – The card networkHISTORICAL – Historical data download for trainingSchema: Expected Values: API, REVIEW_MANAGER, NETWORK, HISTORICAL |
keyValuePair
The following are attributes of thekeyValuePair derived type.| Attribute | Type | Required? | Description |
|---|---|---|---|
| key | string | No | 255 char max |
| value | string | No | 255 char max |