/transactions resource represents the electronic messages that carry information used for payment processing. A transaction usually originates when a cardholder attempts to make a payment, either online or at a physical point of sale.
You can receive information about transactions as they occur by configuring webhooks. Learn about configuring webhooks in the About Webhooks guide. See the transaction events for which you can set up webhooks in the Event Types API reference page.
You can also retrieve transactions associated with specific cards, merchants, and account holders using the endpoints described here.
For an overview of transactions and the transaction object, including the complete list of transaction response codes, see About Transactions.
Tip
Use the
/transactions endpoint to retrieve smaller datasets (up to one page). For best performance when requesting larger datasets, use the DiVA API.Transaction object
Transactions are represented by thetransaction 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.
| Fields | Description |
|---|---|
| account_funding object Optional | Contains details about account funding transactions. Account funding transactions move money into a cardholder’s general purpose account (GPA). Allowable Values: funding_source, receiver_account_type, receiver_name, screening_score, transaction_purpose, transaction_type |
| account_funding.funding_source string Optional | Specifies the type of account from which the transaction was funded. Allowable Values: CREDIT, DEBIT, PREPAID, DEPOSIT_ACCOUNT, CASH, MOBILE_MONEY_ACCOUNT, NON_VISA_CREDIT, CHECK, ACH |
| account_funding.receiver_account_type string Optional | Specifies the type of account receiving the funding. Allowable Values: OTHER, RTN_BANK_ACCOUNT, IBAN, CARD_ACCOUNT, EMAIL, PHONE_NUMBER, BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE, WALLET_ID, SOCIAL_NETWORK_ID |
| account_funding.receiver_name string Optional | Specifies the name of the account holder receiving the funding. Allowable Values: 255 char max |
| account_funding.screening_score string Optional | 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. Allowable Values: 000-100 or 999 |
| account_funding.sender_account_number string Optional | Account number of the sender funding the transaction. Allowable Values: 255 char max |
| account_funding.sender_address string Optional | Street address of the sender funding the transaction. Allowable Values: 255 char max |
| account_funding.sender_city string Optional | City of the sender funding the transaction. Allowable Values: 255 char max |
| account_funding.sender_country string Optional | Country of the sender funding the transaction. Allowable Values: 255 char max |
| account_funding.sender_name string Optional | Name of the sender funding the transaction. Allowable Values: 255 char max |
| account_funding.sender_state string Optional | State or province of the sender funding the transaction. Allowable Values: 255 char max |
| account_funding.transaction_purpose string Optional | Describes the purpose of the account funding transaction. Allowable Values: boleto_payment, crypto_currency, education, emergency_need, family_support, gifts, labor_transfers, lending, medical_treatment, other, recycling_deposit_return, refund_to_new_card, refund_to_original_card, salary, savings, transfer_to_another_person_or_organization_in_the_same_staged_digital_wallet, travel, value_added_tax_payment |
| account_funding.transaction_type string Optional | Specifies the account funding transaction type. Allowable Values: 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, LIQUID_ASSET, FAST_REFUND |
| account_owner object Optional | Information about the owner of an account participating in an account funding or original credit transaction. Allowable Values: country_of_birth, dob, email_address, nationality, occupation |
| account_owner.country_of_birth string Optional | Account owner’s country of birth. Allowable Values: 255 char max |
| account_owner.dob string Optional | Account owner’s date of birth. Allowable Values: 255 char max |
| account_owner.email_address string Optional | Account owner’s email address. Allowable Values: 255 char max |
| account_owner.nationality string Optional | Account owner’s nationality. Allowable Values: 255 char max |
| account_owner.occupation string Optional | Account owner’s occupation. Allowable Values: 255 char max |
| acquirer object Optional | Contains information about the merchant’s financial institution. Allowable Values: Existing acquirer object |
| acquirer.city string Optional | City of the merchant’s financial institution. This field appears only in account funding and original credit transactions. Allowable Values: 255 char max |
| acquirer.country_code string Optional | Country code of the merchant’s financial institution. This field appears only in account funding and original credit transactions. Allowable Values: Valid three-digit ISO 3166 country code |
| acquirer.institution_country string Optional | Country code of the merchant’s financial institution. Allowable Values: Valid three-digit ISO 3166 country code |
| acquirer.institution_id_code string Optional | Identifier code of the merchant’s financial institution. Allowable Values: 255 char max |
| acquirer.merchant_street_address string Optional | Street address of the merchant. This field appears only in account funding and original credit transactions. Allowable Values: 255 char max |
| acquirer.name string Optional | Name of the merchant’s financial institution. This field appears only in account funding and original credit transactions. Allowable Values: 255 char max |
| acquirer.network_international_id string Optional | International network identifier. Allowable Values: 255 char max |
| acquirer.postal_code string Optional | Postal code of the merchant’s financial institution. This field appears only in account funding and original credit transactions. Allowable Values: 255 char max |
| acquirer.state string Optional | State where the merchant’s financial institution is located. This field appears only in account funding and original credit transactions. Allowable Values: 255 char max |
| acquirer.retrieval_reference_number string Optional | Retrieval reference number of the merchant’s financial institution. Allowable Values: 255 char max |
| acquirer.system_trace_audit_number string Optional | System trace audit number of the merchant’s financial institution. Allowable Values: 255 char max |
| acquirer_fee_amount decimal Optional | 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. Allowable Values: decimal Format: 0.00 |
| acquirer_reference_data string Optional | Acquirer-assigned unique identifier of the transaction. Useful for settlement and reconciliation. Allowable Values: 255 char max |
| acquirer_reference_id string Optional | Acquirer-assigned unique identifier of the transaction. Useful for settlement and reconciliation. Allowable Values: 255 char max |
| acting_user_token string Optional | Unique identifier of the user who conducted the transaction. This might be a child user configured to share its parent’s account balance. Allowable Values: 36 char max |
| address_verification object Optional | 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. Allowable Values: on_file, request, response |
| address_verification.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| address_verification.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| address_verification.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| address_verification.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| address_verification.request object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| address_verification.request.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| address_verification.request.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| address_verification.request.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| address_verification.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| address_verification.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| address_verification.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| address_verification.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| account_name_verification object Optional | 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. Allowable Values: on_file, request, response |
| account_name_verification.on_file object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| account_name_verification.on_file.first_name string Optional | First or given name of the cardholder. Allowable Values: 255 char max |
| account_name_verification.on_file.last_name string Optional | Last or family name of the cardholder. Allowable Values: 255 char max |
| account_name_verification.on_file.middle_name string Optional | Middle name of the cardholder. Allowable Values: 255 char max |
| account_name_verification.request object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| account_name_verification.request.first_name string Optional | First or given name of the cardholder. Allowable Values: 255 char max |
| account_name_verification.request.last_name string Optional | Last or family name of the cardholder. Allowable Values: 255 char max |
| account_name_verification.request.middle_name string Optional | Middle name of the cardholder. Allowable Values: 255 char max |
| account_name_verification.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| account_name_verification.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| account_name_verification.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| account_name_verification.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| advice_reason_code string Optional | Extended stand-in processing (STIP) reason code, as provided by the card network. Allowable Values: Reason code, as provided by the card network |
| advice_reason_details string Optional | Extended stand-in processing (STIP) reason details, as provided by the card network. Allowable Values: Reason details, as provided by the card network |
| amount decimal Required | Amount of the transaction. Allowable Values: decimal Format: 0.00 |
| amount_to_be_released decimal Optional | Amount of original authorization to be released. This field appears in final clearing transactions where the clearing amount is lower than the authorization amount. Allowable Values: decimal Format: 0.00 |
| anticipated_amount decimal Optional | Anticipated amount of the transaction, as provided by the card network. This field applies to anticipated amount verification transactions (AAVTs). Allowable Values: decimal Format: 0.00 |
| approval_code string Optional | Unique identifier assigned to an authorization, printed on the receipt at point of sale. Allowable Values: 255 char max |
| auto_reload object Optional | Contains information about an auto reload. See Auto Reloads for more information. Returned if an auto reload was executed. Allowable Values: active, association, currency_code, funding_source_address_token, funding_source_token, order_scope, token |
| auto_reload.active boolean Optional | Specifies whether the auto reload is active. Only one auto reload per level, per object, can be active. Allowable Values: true, falseDefault value: true |
| auto_reload.association object Optional | 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. Allowable Values: business_token, card_product_token, user_token |
| auto_reload.association.business_token string Optional | Unique identifier of the business for which the auto reload is configured. Send a GET request to /businesses to retrieve business tokens.Allowable Values: 1–36 chars |
| auto_reload.association.card_product_token string Optional | Unique identifier of the card product for which the auto reload is configured. Send a GET request to /cardproducts to retrieve card product tokens.Allowable Values: 1–36 chars |
| auto_reload.association.user_token string Optional | Unique identifier of the user for which the auto reload is configured. Send a GET request to /users to retrieve user tokens.Allowable Values: 1–36 chars |
| auto_reload.currency_code string Required | Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
| auto_reload.funding_source_address_token string Optional | 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/ to retrieve address tokens for a user.Send a GET request to /fundingsources/addresses/business/ to retrieve address tokens for a business.Allowable Values: 1–36 chars |
| auto_reload.funding_source_token string Optional | Unique identifier of the funding source to use for this auto reload. Send a GET request to /fundingsources/user/ to retrieve funding source tokens for a user.Send a GET request to /fundingsources/business/ to retrieve funding source tokens for a business.Allowable Values: 1–36 chars |
| auto_reload.order_scope object Required | Defines the balance threshold and reload amounts. Allowable Values: gpa |
| auto_reload.order_scope.gpa object Optional | Defines the type of order. Allowable Values: reload_amount, trigger_amount |
| auto_reload.order_scope.gpa.reload_amount decimal Required | 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.Allowable Values: 0.01 min |
| auto_reload.order_scope.gpa.trigger_amount decimal Required | Threshold that determines when the reload happens. The reload is triggered when the card balance falls below this amount. Allowable Values: 0.01 min |
| auto_reload.token string Optional | 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. Allowable Values: 1–36 chars |
| batch_number string Optional | The batch number of the transaction. Allowable Values: 255 char max |
| business object Optional | Contains customer-provided information about the business that funded the transaction. Allowable Values: Existing business metadata |
| business.metadata object Optional | Associates customer-provided metadata with the business. Allowable Values: Up to 20 name-value pair fields in “field_name_1”: “field_value_1” format. |
| business_token string Optional | Unique identifier of the business that owns the account that funded the transaction. Allowable Values: 36 char max |
| card object Optional | Contains information about the card used in the transaction. Allowable Values: activation_actions, barcode, bulk_issuance_token, card_product_token, chip_cvv_number, contactless_exemption_counter,contactless_exemption_total_amount, contactless_exemption_transaction_currency, created_time, cvv_number, expidite, expiration, expiration_time, fulfillment, fulfillment_status, instrument_type, last_four, last_modified_time, metadata, pan, pin_is_set, reissue_pan_from_card_token, new_pan_from_card_token, state, state_reason, token, translate_pin_from_card_token, user_token |
| card.activation_actions object Optional | Defines actions to execute when the card is activated. The fields in this object are mutually exclusive. Allowable Values: swap_digital_wallet_tokens_from_card_token, terminate_reissued_source_card |
| card.activation_actions.swap_digital_wallet_tokens_from_card_token string Optional | 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/ to retrieve card tokens for a particular user.Allowable Values: 1–36 chars Existing card token |
| card.activation_actions.terminate_reissued_source_card boolean Optional | 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.Allowable Values: true, falseDefault value: true |
| card.barcode string Required | Barcode printed on the card, expressed as numerals. Allowable Values: 10-20 chars |
| card.bulk_issuance_token string Optional | Unique identifier of the bulk card order. Allowable Values: 1-36 chars |
| card.card_product_token string Required | Unique identifier of the card product. Allowable Values: 1-36 chars |
| card.chip_cvv_number string Optional | Three-digit card verification value (ICVV) stored on the chip of the card. Allowable Values: 3 chars |
| card.contactless_exemption_counter integer Optional | 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 Card Products. Allowable Values: Any integer |
| card.contactless_exemption_total_amount decimal Optional | 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 Card Products. Allowable Values: Any integer |
| card.contactless_exemption_transaction_currency string Optional | Indicates the currency type of the transaction. Allowable Values: Valid three-character ISO 4217 currency code |
| card.created_time datetime Required | Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| card.cvv_number string Optional | Three-digit card verification value (CVV2 or CVC2) printed on the card. Allowable Values: 3 chars |
| card.expedite boolean Optional | A value of true indicates that you requested expedited processing of the card from your card fulfillment provider.Allowable Values: true, false |
| card.expiration string Required | Expiration date in MMyy format.Allowable Values: Format: MMyy |
| card.expiration_time datetime Required | Expiration date and time, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| card.fulfillment object Optional | Determines physical characteristics of a card and shipment information. Allowable Values: card_fulfillment_reason, card_personalization, shipping |
| card.fulfillment.card_fulfillment_reason string Optional | Descriptive reason for the card fulfillment. Allowable Values: NEW, LOST_STOLEN, EXPIRED |
| card.fulfillment.card_personalization object Required | Specifies personalized attributes to be added to the card. Allowable Values: carrier, images, perso_type, text |
| card.fulfillment.card_personalization.carrier object Optional | Specifies attributes of the card carrier. Allowable Values: logo_file, logo_thumbnail_file, message_file, message_line, template_id |
| card.fulfillment.card_personalization.carrier.logo_file string Optional | Specifies an image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
| card.fulfillment.card_personalization.carrier.logo_thumbnail_file string Optional | Specifies a thumbnail-sized rendering of the image specified in the logo_file field.Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
| card.fulfillment.card_personalization.carrier.message_file string Optional | Specifies a text file containing a custom message to print on the card carrier. Allowable Values: Contains the name of the text file and must match the name of the file you send to your fulfillment provider. |
| card.fulfillment.card_personalization.carrier.message_line string Optional | Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
| card.fulfillment.card_personalization.carrier.message_line_2 string Optional | Specifies the second line of a custom message that appears on the card carrier. Allowable Values: 60 char max |
| card.fulfillment.card_personalization.carrier.template_id string Optional | Specifies the card carrier template to use. Allowable Values: Card carrier template ID |
| card.fulfillment.card_personalization.images object Optional | Specifies personalized images that appear on the card. Allowable Values: card, carrier, carrier_return_window, signature |
| card.fulfillment.card_personalization.images.card object Optional | Specifies personalized images that appear on the card. Allowable Values: name, thermal_color |
| card.fulfillment.card_personalization.images.card.name string Optional | Specifies a PNG image to display on the card. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
| card.fulfillment.card_personalization.images.card.thermal_color string Optional | Specifies the color of the image displayed on the card. Allowable Values: Contains the name of the color and must match one of the provider’s predefined colors. |
| card.fulfillment.card_personalization.images.carrier object Optional | Specifies personalized images that appear on the card carrier. Allowable Values: message_1, name |
| card.fulfillment.card_personalization.images.carrier.message_1 string Optional | Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
| card.fulfillment.card_personalization.images.carrier.name string Optional | Specifies a PNG image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
| card.fulfillment.card_personalization.images.carrier_return_window object Optional | Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: name |
| card.fulfillment.card_personalization.images.carrier_return_window.name string Optional | Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
| card.fulfillment.card_personalization.images.signature object Optional | Specifies a PNG image of the cardholder’s signature. Allowable Values: name |
| card.fulfillment.card_personalization.images.signature.name string Optional | Specifies a PNG image of the cardholder’s signature. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
| card.fulfillment.card_personalization.perso_type string Optional | Specifies the type of card personalization. Allowable Values: EMBOSS, LASER, FLAT |
| card.fulfillment.card_personalization.text object Required | Specifies personalized text that appears on the card. Allowable Values: name_line_1, name_line_2, name_line_3 |
| card.fulfillment.card_personalization.text.name_line_1 object Required | Specifies the first line of personalized text that appears on the card. Allowable Values: name_line_1.value21 char max; if name_line_1_numeric_postfix is true, 14 char max.Strings longer than the character limit are truncated. |
| card.fulfillment.card_personalization.text.name_line_1.value string Optional | Line of personalized text printed on the card. Allowable Values: 21 char max |
| card.fulfillment.card_personalization.text.name_line_2 object Optional | Specifies the second line of personalized text that appears on the card. Allowable Values: name_line_2.value |
| card.fulfillment.card_personalization.text.name_line_2.value string Optional | Line of personalized text printed on the card. Allowable Values: 21 char max |
| card.fulfillment.card_personalization.text.name_line_3 object Optional | Specifies the third line of personalized text that appears on the card. Allowable Values: name_line_3.value |
| card.fulfillment.card_personalization.text.name_line_3.value string Optional | Line of personalized text printed on the card. Allowable Values: 21 char max |
| card.fulfillment.shipping object Optional | Specifies shipping details for the order. This object is returned if it exists in the resource. Allowable Values: care_of_line, method, recipient_address, return_address |
| card.fulfillment.shipping.care_of_line string Optional | Specifies the value of the care of (C/O) line on the mailing carrier. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| card.fulfillment.shipping.method string Optional | Specifies the shipping service. This field is returned if it exists in the resource. Allowable Values: 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 |
| card.fulfillment.shipping.recipient_address object Optional | Address to which the order will be shipped. This field is returned if it exists in the resource. Allowable Values: Existing recipient_address object |
| card.fulfillment.shipping.recipient_address.address1 string Optional | Number and street of the address. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
| card.fulfillment.shipping.recipient_address.address2 string Optional | Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
| card.fulfillment.shipping.recipient_address.city string Optional | City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| card.fulfillment.shipping.recipient_address.country string Optional | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name “Spain”. The ISO maintains the full list of country codes. |
| card.fulfillment.shipping.recipient_address.first_name string Optional | First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| card.fulfillment.shipping.recipient_address.last_name string Optional | Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| card.fulfillment.shipping.recipient_address.middle_name string Optional | Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| card.fulfillment.shipping.recipient_address.phone string Optional | Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| card.fulfillment.shipping.recipient_address.postal_code string Optional | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
| card.fulfillment.shipping.recipient_address.state string Optional | State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max |
| card.fulfillment.shipping.recipient_address.zip string Optional | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
| card.fulfillment.shipping.return_address object Optional | Address to which the order will be returned if shipping fails. This object is returned if it exists in the resource. Allowable Values: Existing return_address object |
| card.fulfillment.shipping.return_address.address1 string Optional | Number and street of the address. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
| card.fulfillment.shipping.return_address.address2 string Optional | Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. |
| card.fulfillment.shipping.return_address.city string Optional | City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| card.fulfillment.shipping.return_address.country string Optional | Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name “Spain”. The ISO maintains the full list of country codes. |
| card.fulfillment.shipping.return_address.first_name string Optional | First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| card.fulfillment.shipping.return_address.last_name string Optional | Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| card.fulfillment.shipping.return_address.middle_name string Optional | Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
| card.fulfillment.shipping.return_address.phone string Optional | Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max |
| card.fulfillment.shipping.return_address.postal_code string Optional | Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
| card.fulfillment.shipping.return_address.state string Optional | State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max |
| card.fulfillment.shipping.return_address.zip string Optional | United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
| card.fulfillment_status string Required | 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//showpan endpoint; does not affect the delivery of physical cards.Allowable Values: ISSUED, ORDERED, REORDERED, REJECTED, SHIPPED, DELIVERED, DIGITALLY_PRESENTED |
| card.instrument_type string Optional | 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). Allowable Values: PHYSICAL_MSR, PHYSICAL_ICC, PHYSICAL_CONTACTLESS, PHYSICAL_COMBO, VIRTUAL_PAN |
| card.last_four string Required | Last four digits of the card primary account number (PAN). Allowable Values: 4 chars |
| card.last_modified_time datetime Required | Date and time when the resource was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| card.metadata object Optional | Associates customer-provided metadata with the card. Allowable Values: Contains the names and values of up to 20 fields in the format “my_name_1”: “my_value_1” |
| card.pan string Required | Primary account number (PAN) of the card. Allowable Values: 16 char max |
| card.pin_is_set boolean Required | Specifies if the personal identification number (PIN) has been set for the card. Allowable Values: 4 chars |
| card.reissue_pan_from_card_token string Optional | Reissues the specified card (known as the “source” card). Allowable Values: Existing card token |
| card.new_pan_from_card_token string Optional | Reissues the specified card (known as the “source” card) with a new primary account number (PAN). Allowable Values: Existing card token |
| card.state string Required | Indicates the state of the card. Allowable Values: ACTIVE, SUSPENDED, TERMINATED, UNSUPPORTED, UNACTIVATED, LIMITED |
| card.state_reason string Required | Descriptive reason for why the card is in its current state. For example, “Card activated by cardholder”. Allowable Values: 255 char max |
| card.token string Required | Unique identifier of the card. Allowable Values: Existing card token |
| card.translate_pin_from_card_token string Optional | Copies the personal identification number (PIN) from the specified source card to the newly created card. Allowable Values: Existing card token |
| card.user_token string Required | Unique identifier of the cardholder. Allowable Values: Existing user token |
| card_acceptor object Optional | Contains information about the merchant. Allowable Values: Existing card_acceptor object |
| card_acceptor.address string Optional | 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. Allowable Values: 255 char max |
| card_acceptor.business_registration_id string Optional | Business registration identifier, as provided by the Visa card network. Allowable Values: 255 char max |
| card_acceptor.business_registration_id_type string Optional | Business registration identifier type, as provided by the Visa card network. Allowable Values: 255 char max |
| card_acceptor.city string Optional | Card acceptor’s city. Allowable Values: 40 char max |
| card_acceptor.country_code string Optional | 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. Allowable Values: Valid alpha-3 ISO 3166 country code |
| card_acceptor.geographic_coordinates string Optional | For Mastercard only. Geographic coordinates of the card acceptor in latitudeE7,longitudeE7 format.Allowable Values: 255 char max Example Value: 3781100,-12226302 |
| card_acceptor.legal_business_name string Optional | Legal business name, as provided by the Visa card network. Allowable Values: 255 char max |
| card_acceptor.mcc string Optional | Merchant category code (MCC). Allowable Values: Existing MCC |
| card_acceptor.mcc_groups array of strings Optional | An array of mcc_groups.Allowable Values: Valid array of one or more mcc_groups |
| card_acceptor.mid string Optional | The merchant identifier. Allowable Values: 255 char max |
| card_acceptor.name string Optional | Card acceptor’s name. Allowable Values: 50 char max |
| card_acceptor.network_assigned_id string Optional | Identifier assigned by the card network. Allowable Values: 255 char max |
| card_acceptor.network_mid string Optional | The merchant identifier on the card network. Allowable Values: 255 char max |
| card_acceptor.poi object Optional | 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. Allowable Values: card_presence, cardholder_presence, partial_approval_capable, pin_present, special_condition_indicator, tid |
| card_acceptor.poi.card_presence string Optional | Indicates whether the card was present during the transaction. Allowable Values: 255 char max |
| card_acceptor.poi.cardholder_presence string Optional | Indicates whether the cardholder was present during the transaction. Allowable Values: 255 char max |
| card_acceptor.poi.partial_approval_capable string Optional | Indicates whether the card acceptor or terminal supports partial-approval transactions. Allowable Values: 255 char max |
| card_acceptor.poi.pin_present string Optional | Indicates whether the cardholder entered a PIN during the transaction. Allowable Values: 255 char max |
| card_acceptor.poi.special_condition_indicator string Optional | Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction. These transactions typically involve non-financial institutions. Allowable Values: CRYPTOCURRENCY_PURCHASE, DEBT_PAYMENT, QUASI_CASH, CENTRAL_BANK_DIGITAL_CURRENCY_PURCHASE, STABLECOIN_PURCHASE, BLOCKCHAIN_NATIVE_TOKEN_PURCHASE, NON_FUNGIBLE_TOKEN_PURCHASE, UNSPECIFIED |
| card_acceptor.poi.tid string Optional | Card acceptor or terminal identification number. Allowable Values: 255 char max |
| card_acceptor.poi.transaction_initiated_by string Optional | Specifies the initiator of the transaction. Allowable Values: CONSUMER, MERCHANT, UNKNOWN |
| card_acceptor.poi.transaction_initiated_category string Optional | Specifies the category of a point-of-sale transaction. Allowable Values: 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 |
| card_acceptor.postal_code string Optional | Card acceptor’s postal code. Allowable Values: 255 char max |
| card_acceptor.service_geographic_coordinates string Optional | For Mastercard only. Geographic coordinates of the service provider in latitudeE7,longitudeE7 format.Allowable Values: 255 char max Example Value: 3781100,-12226302 |
| card_acceptor.state string Optional | State, provincial, territorial, or federal abbreviation (CA for California or CAN for Canada, for example).For the complete list, see Valid state, provincial, territorial, and federal abbreviations. Note: Non-US merchants may return more than 2 char for this field. Allowable Values: 2 char max |
| card_acceptor.country_of_origin string Optional | 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. Allowable Values: 255 char max |
| card_acceptor.transfer_service_provider_name string Optional | 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. Allowable Values: 25 char max |
| card_acceptor.merchant_vat_registration_id string Optional | The VAT registration identifier of the merchant. Allowable Values: 255 char max |
| card_acceptor.payment_facilitator_name string Optional | 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. Allowable Values: 25 char max |
| card_holder_model object Optional | Contains information about a cardholder. Allowable Values: account_holder_group_token, active, address1, address2, authentication, birth_date, birth_place, business_token, city, company, corporate_card_holder, country, created_time, email, first_name, gender, honorific, id_card_expiration_date, id_card_number, identifications, ip_address, last_modified_time, last_name, metadata, middle_name, nationality, notes, parent_token, passport_expiration_date, passport_number, password, phone, postal_code, ssn, state, status, title, token, uses_parent_account, zip |
| card_holder_model.account_holder_group_token string Optional | Associates the specified account holder group with the cardholder. Allowable Values: 36 char max |
| card_holder_model.active boolean Optional | Specifies if the cardholder is in the ACTIVE state on the Marqeta platform.Allowable Values: true, false |
| card_holder_model.address1 string Optional | Cardholder’s address. Allowable Values: 255 char max |
| card_holder_model.address2 string Optional | Additional address information for the cardholder. Allowable Values: 255 char max |
| card_holder_model.authentication object Optional | Contains the cardholder’s email address and password information. Allowable Values: email_verified, email_verified_time, last_password_update_channel, last_password_update_time |
| card_holder_model.authentication.email_verified boolean Optional | Specifies whether the email address has been verified. Allowable Values: true, false |
| card_holder_model.authentication.email_verified_time datetime Optional | Date and time when the email address was verified. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| card_holder_model.authentication.last_password_update_channel string Optional | Specifies the channel through which the password was last changed. Allowable Values: USER_CHANGE, USER_RESET |
| card_holder_model.authentication.last_password_update_time datetime Optional | Date and time when the password was last changed. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| card_holder_model.birth_date string Optional | Cardholder’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| card_holder_model.birth_place string Optional | Country where the cardholder was born. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| card_holder_model.business_token string Optional | Unique identifier of the business resource. Allowable Values: Existing business resource token |
| card_holder_model.city string Optional | City where the cardholder resides. Allowable Values: 40 char max |
| card_holder_model.company string Optional | Company name. Allowable Values: 255 char max |
| card_holder_model.corporate_card_holder boolean Optional | Specifies if the cardholder holds a corporate card. Allowable Values: true, false |
| card_holder_model.country string Optional | Country where the cardholder resides. Allowable Values: 40 char max |
| card_holder_model.created_time datetime Required | Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| card_holder_model.email string Optional | Valid email address of the cardholder. Allowable Values: 1–255 chars |
| card_holder_model.first_name string Optional | Cardholder’s first name. Allowable Values: 40 char max |
| card_holder_model.gender string Optional | Gender of the cardholder. Allowable Values: F, M |
| card_holder_model.honorific string Optional | Cardholder’s title or prefix: Dr., Miss, Mr., Ms., and so on. Allowable Values: 10 char max |
| card_holder_model.id_card_expiration_date string Optional | Expiration date of the cardholder’s identification. Allowable Values: Format: yyyy-MM-dd |
| card_holder_model.id_card_number string Optional | Cardholder’s identification card number. Allowable Values: 255 char max |
| card_holder_model.identifications array of objects Optional | One or more objects containing identifications associated with the cardholder. Allowable Values: Valid array of one or more identifications objects |
| card_holder_model.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| card_holder_model.identifications[].type string Optional | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| card_holder_model.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max |
| card_holder_model.ip_address string Optional | Cardholder’s IP address. Allowable Values: 39 char max |
| card_holder_model.last_modified_time datetime Required | Date and time when the resource was last updated, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| card_holder_model.last_name string Optional | Cardholder’s last name. Allowable Values: 40 char max |
| card_holder_model.metadata object Optional | Associates any additional metadata you provide with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format “my_name_1”: “my_value_1” |
| card_holder_model.middle_name string Optional | Cardholder’s middle name. Allowable Values: 40 char max |
| card_holder_model.nationality string Optional | Cardholder’s nationality. Allowable Values: 255 char max |
| card_holder_model.notes string Optional | Any additional information pertaining to the cardholder. Allowable Values: 255 char max |
| card_holder_model.parent_token string Optional | Unique identifier of the parent user or business resource. Allowable Values: 1–36 chars |
| card_holder_model.passport_expiration_date string Optional | Expiration date of the cardholder’s passport. Allowable Values: Format: yyyy-MM-dd |
| card_holder_model.passport_number string Optional | Cardholder’s passport number. Allowable Values: 40 char max |
| card_holder_model.password string Optional | Password to the cardholder’s user account on the Marqeta platform. Allowable Values: 1–255 chars |
| card_holder_model.phone string Optional | Cardholder’s telephone number. Allowable Values: 255 char max |
| card_holder_model.postal_code string Optional | Postal code of the cardholder’s address. Allowable Values: 10 char max |
| card_holder_model.ssn string Optional | Cardholder’s Social Security Number (SSN). Allowable Values: Nine digits only, no delimiters. |
| card_holder_model.state string Optional | State or province where the cardholder resides. Allowable Values: 2 char max |
| card_holder_model.status string Optional | Specifies the status of the cardholder on the Marqeta platform. Allowable Values: UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED |
| card_holder_model.title string Optional | Professional title of the cardholder, such as Chief Comptroller. Allowable Values: 255 char max |
| card_holder_model.token string Optional | Unique identifier of the cardholder. Allowable Values: 1–36 chars |
| card_holder_model.uses_parent_account boolean Optional | Indicates whether the child shares balances with the parent (true), or the child’s balances are independent of the parent (false).Allowable Values: true, false |
| card_holder_model.zip string Optional | United States ZIP code of the cardholder’s address. Allowable Values: 10 char max |
| card_product_token string Optional | Unique identifier of the card product. Allowable Values: 36 char max |
| card_security_code_verification object Optional | Contains information about a verification check performed on the card’s security code. Allowable Values: Existing card_security_code_verification object |
| card_security_code_verification.response object Required | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| card_security_code_verification.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| card_security_code_verification.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| card_security_code_verification.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| card_security_code_verification.type string Required | 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. Allowable Values: CVV1, CVV2, ICVV, DCVV |
| card_token string Optional | Unique identifier of the card. Useful when a single account holder has multiple cards. Allowable Values: 36 char max |
| cardholder_authentication_data object Optional | 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.Allowable Values: Existing cardholder_authentication_data object |
| cardholder_authentication_data.acquirer_exemption array of strings Optional | Indicates 3D Secure authentication exemptions from the acquirer. This array is returned if it is included in the transaction data from the card network. Allowable Values: MERCHANT_INITIATED_TRANSACTION, TRANSACTION_RISK_ANALYSIS, RECURRING_PAYMENT, LOW_VALUE_PAYMENT, SCA_PERFORMED, SECURE_CORPORATE_PAYMENT, AUTHENTICATION_OUTAGE_EXCEPTION |
| cardholder_authentication_data.authentication_method string Optional | Specifies the 3D Secure authentication method. Allowable Values: null, AUDIO_CALL, BEHAVIORAL_BIOMETRICS, BIOMETRIC, BIOMETRIC_FACE, BIOMETRIC_FINGERPRINT, CHALLENGE, DECOUPLED, DELEGATED_TRUSTED_AUTHENTICATION, FRICTIONLESS, FRICTIONLESS_FIDO, FRICTIONLESS_SMART_ATTEMPTS, IN_APP_LOGIN, KNOWLEDGE_BASED, MDES, OOB, OOB_OTHER, OTHER, OTP, OTP_SMS, OTP_EMAIL, SECURE_PAYMENT_CONFM, STAND_IN_FRICTIONLESS, VIDEO_CALL, VOICE_RECOGNITION, WEB_AUTHN, OTHER, UNKNOWN |
| cardholder_authentication_data.authentication_status string Optional | 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. Allowable Values: ATTEMPTED, DATA_SHARE_EXEMPTED, EXEMPTED, EXEMPTION_CLAIMED, SCA_EXEMPTION, SUCCESSFUL, SUCCESSFUL_NON_PAYMENT, THREEDS_REQUESTER_DATA_SHARE_EXEMPTION, THREEDS_REQUESTER_SCA_EXEMPTION, THREEDS_REQUESTER_TRA_EXEMPTION, UNAVAILABLE |
| cardholder_authentication_data.electronic_commerce_indicator string Optional | 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.Allowable Values: authentication_attempted, authentication_successful, no_authentication |
| cardholder_authentication_data.issuer_exemption string Optional | 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. Allowable Values: SCA_LOW_VALUE_PAYMENT |
| cardholder_authentication_data.three_ds_message_version string Optional | Specifies the 3D Secure message version used for authentication. Allowable Values: 1.0.2, 2.1.0, 2.2.0 |
| cardholder_authentication_data.three_ds_reference_id string Optional | The 3D Secure authentication indicator, as provided by the Mastercard card network. Allowable Values: 255 char max |
| cardholder_authentication_data.verification_result string Optional | 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.Allowable Values: failed, not_present, not_provided, not_verified, not_verified_authentication_outage, verified, verified_amount_checked, verified_amount_greater_than_20_percent, verified_amount_less_than_20_percent, not_verified_mac_key_validation_passed, not_verified_mac_key_validation_failed |
| cardholder_authentication_data.verification_value_created_by string Optional | Transaction participant who determined the verification result. Allowable Values: issuer_acs, issuer_attempts_server, network, network_attempts_server |
| cardholder_authentication_data.cavv_authentication_amount string Optional | 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. Allowable Values: 255 char max |
| cardholder_authentication_data.raw_cavv_data string Optional | 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. Allowable Values: 255 char max |
| cash_back_amount decimal Optional | Amount of cash back requested by the cardholder during the transaction. Included in the total transaction amount. Allowable Values: decimal Format: 0.00 |
| chargeback object Optional | Contains the chargeback object associated with this transaction if a chargeback has been initiated. Allowable Values: Existing chargeback object |
| chargeback.amount decimal Required | Amount of the chargeback. Allowable Values: 0.01 min |
| chargeback.channel string Required | Channel the chargeback came through. Allowable Values: GATEWAY, GATEWAY_AUTOMATED, ISSUER, ISSUER_AUTOMATED |
| chargeback.created_time datetime Required | Date and time when the chargeback was created. Not returned for transactions when the associated chargeback is in the INITIATED state.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| chargeback.credit_user boolean Required | Whether to credit the user for the chargeback amount. Allowable Values: true, false |
| chargeback.last_modified_time datetime Required | Date and time when the chargeback was last modified. Not returned for transactions when the associated chargeback is in the INITIATED state.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| chargeback.memo string Optional | Additional comments about the chargeback. Allowable Values: 1–1024 chars |
| chargeback.network string Required | Network handling the chargeback. Allowable Values: MARQETA, DISCOVER, MASTERCARD, PULSE, VISA |
| chargeback.network_case_id string Optional | Network-assigned identifier of the chargeback. Allowable Values: 50 char max |
| chargeback.reason_code string Optional | Identifies the standardized reason for the chargeback. Allowable Values: See The reason_code field in the Disputes (Visa) API reference. |
| chargeback.state string Required | State of the case. Allowable Values: INITIATED, REPRESENTMENT, PREARBITRATION, ARBITRATION, CASE_WON, CASE_LOST, NETWORK_REJECTED, WITHDRAWN |
| chargeback.token string Required | Unique identifier of the chargeback. Allowable Values: 1–36 chars |
| chargeback.transaction_token string Required | Unique identifier of the transaction being charged back. Allowable Values: 1–36 chars |
| clearing_record_sequence_number string Optional | A sequence number that identifies a specific clearing message among multiple clearing messages for an authorization. Allowable Values: Sequence number returned in the clearing record |
| created_time datetime Optional | 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. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| currency_code string Optional | Currency type of the transaction. Allowable Values: Valid three-digit ISO 4217 currency code |
| currency_conversion object Optional | Contains information about currency conversion. Allowable Values: Existing currency_conversion object |
| currency_conversion.network object Optional | 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. Allowable Values: Existing network object |
| currency_conversion.network.conversion_rate decimal Optional | Conversion rate between the origination currency and the settlement currency. Returned when the transaction currency is different from the origination currency. Allowable Values: Current conversion rate. NOTE: A value of 0 or 1 indicates no conversion; the currencies are the same. |
| currency_conversion.network.dynamic_currency_conversion boolean Optional | Indicates whether currency conversion was performed dynamically at the point of sale. Allowable Values: true, false |
| currency_conversion.network.original_amount decimal Optional | Amount of the transaction in the currency in which it originated. Allowable Values: Decimal amount. |
| currency_conversion.network.original_currency_code string Optional | Currency type of the origination currency. Allowable Values: Valid three-digit ISO 4217 currency code |
| currency_conversion.network.settlement_data object Optional | 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. Allowable Values: Existing settlement_data object |
| currency_conversion.network.settlement_data.amount decimal Optional | The settled amount. Allowable Values: decimal Format: 0.00 |
| currency_conversion.network.settlement_data.conversion_rate decimal Optional | Returned when the transaction currency is different from the origination currency. Conversion rate between the origination currency and the settlement currency. Allowable Values: Current conversion rate. NOTE: A value of 0 or 1 indicates no conversion; the currencies are the same. |
| currency_conversion.network.settlement_data.currency_code string Optional | The ISO 4217 code of the currency used in the transaction. Allowable Values: Valid three-digit ISO 4217 currency code |
| digital_commerce_authentication_indicator string Optional | 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. - 01: Visa Digital Authentication Framework - 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 Allowable Values: 01, 02, 03, 04, 05, 06, 07 |
| digital_commerce_authentication_program object Optional | Contains consumer contact and billing address data received in Visa’s Digital Commerce Authentication Program (DCAP) Field 56 for authenticated e-commerce transactions. Populated only for DCAP-authenticated transactions. Allowable Values: phone_number, email_address, billing_address_line_1, billing_address_line_2, billing_street_name, billing_building_number, billing_postal_code, billing_city, billing_subdivision_minor, billing_subdivision_major, billing_country_code |
| digital_commerce_authentication_program.phone_number string Optional | Cardholder phone number provided through DCAP. Allowable Values: 16 char max |
| digital_commerce_authentication_program.email_address string Optional | Cardholder email address provided through DCAP. Allowable Values: 99 char max |
| digital_commerce_authentication_program.billing_address_line_1 string Optional | First line of the cardholder billing address. Allowable Values: 50 char max |
| digital_commerce_authentication_program.billing_address_line_2 string Optional | Second line of the cardholder billing address. Allowable Values: 50 char max |
| digital_commerce_authentication_program.billing_street_name string Optional | Street name of the cardholder billing address. Allowable Values: 50 char max |
| digital_commerce_authentication_program.billing_building_number string Optional | Building or house number of the cardholder billing address. Allowable Values: 16 char max |
| digital_commerce_authentication_program.billing_postal_code string Optional | Postal or ZIP code of the cardholder billing address. Allowable Values: 16 char max |
| digital_commerce_authentication_program.billing_city string Optional | City of the cardholder billing address. Allowable Values: 25 char max |
| digital_commerce_authentication_program.billing_subdivision_minor string Optional | ISO 3166-2 minor country subdivision code of the billing address. Allowable Values: 16 char max |
| digital_commerce_authentication_program.billing_subdivision_major string Optional | ISO 3166-2 major country subdivision (state or province) code of the billing address. Allowable Values: 3 char max |
| digital_commerce_authentication_program.billing_country_code string Optional | ISO 3166-1 country code of the billing address. Allowable Values: 3 char max |
| digital_wallet_token object Optional | 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 Digital Wallets Management API reference and Digital Wallets and Tokenization developer guide. Allowable Values: address_verification, card_token, created_time, device, fulfillment_status, issuer_eligibility_decision, last_modified_time, metadata, state, state_reason, token, token_service_provider, user, wallet_provider_profile |
| digital_wallet_token.address_verification object Optional | Contains address verification information. Allowable Values: name, postal_code, street_address, zip |
| digital_wallet_token.address_verification.name string Optional | Name of the cardholder. Allowable Values: 40 char max |
| digital_wallet_token.address_verification.postal_code string Optional | Postal code. Allowable Values: 10 char max |
| digital_wallet_token.address_verification.street_address string Optional | Street address provided by the cardholder. Allowable Values: 40 char max |
| digital_wallet_token.address_verification.zip string Optional | United States ZIP code. Allowable Values: 10 char max |
| digital_wallet_token.card_token string Optional | Unique identifier of the card. Allowable Values: Existing card token |
| digital_wallet_token.created_time datetime Optional | Date and time when the digital wallet token object was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| digital_wallet_token.device object Optional | Contains information related to the device being provisioned. Allowable Values: device_id, ip_address, language_code, location, name, phone_number, token, type |
| digital_wallet_token.device.device_id string Optional | Identity number of the device. Allowable Values: 24 char max |
| digital_wallet_token.device.ip_address string Optional | Device’s IP address. Allowable Values: IP address format, 50 char max |
| digital_wallet_token.device.language_code string Optional | Language the device is configured to use. Allowable Values: 50 char max |
| digital_wallet_token.device.location string Optional | Geographic coordinates of the device. Allowable 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. |
| digital_wallet_token.device.name string Optional | Name of the device. Allowable Values: 50 char max |
| digital_wallet_token.device.phone_number string Optional | Device’s telephone number. Allowable Values: 50 char max |
| digital_wallet_token.device.token string Optional | Unique identifier of the device object. Allowable Values: 36 char max |
| digital_wallet_token.device.type string Optional | Type of device being provisioned. Allowable Values: MOBILE_PHONE, WATCH, TABLET, MOBILE_PHONE_OR_TABLET, VEHICLE, APPLIANCE, LAPTOP, GAMING_DEVICE, WEARABLE_DEVICE, UNKNOWN |
| digital_wallet_token.fulfillment_status string Optional | Digital wallet token’s provisioning status. For fulfillment status descriptions, see Create digital wallet token transition. Allowable Values: DECISION_RED, DECISION_YELLOW, DECISION_GREEN, REJECTED, PROVISIONED |
| digital_wallet_token.issuer_eligibility_decision string Optional | 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.Allowable 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 |
| digital_wallet_token.last_modified_time datetime Optional | Date and time when the digital wallet token object was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| digital_wallet_token.metadata object Optional | Contains additional information about the digital wallet token. Allowable Values: cardproduct_preferred_notification_language, issuer_product_config_id |
| digital_wallet_token.metadata.cardproduct_preferred_notification_language string Optional | Language specified in the config.transaction_controls.notification_language field of the card product:- ces – Czech - deu – German - eng – English - fra – French - ell – Greek - ita – Italian - nld – Dutch - pol – Polish - por – Portuguese - ron – Romanian - spa – Spanish - swe – Swedish By default, notifications are sent in English. The ISO maintains the full list of ISO 3166 two- and three-digit numeric country codes. Allowable Values: ces, deu, eng, fra, ell, ita, nld, pol, por, ron, spa, swe |
| digital_wallet_token.metadata.issuer_product_config_id string Optional | Unique identifier of the product configuration on the Marqeta platform. Allowable Values: 255 char max |
| digital_wallet_token.state string Optional | State of the digital wallet token. For state descriptions, see Transitioning Token States. Allowable Values: REQUESTED, REQUEST_DECLINED, ACTIVE, SUSPENDED, TERMINATED |
| digital_wallet_token.state_reason string Optional | Reason why the digital wallet token transitioned to its current state. Allowable Values: 255 char max |
| digital_wallet_token.token string Optional | Unique identifier of the digital wallet token. Allowable Values: Existing digital wallet token. |
| digital_wallet_token.token_service_provider object Optional | Contains information held and provided by the token service provider (card network). Allowable Values: correlation_id, pan_reference_id, token_assurance_level, token_eligibility_decision, token_expiration, token_pan, token_reference_id, token_requestor_id, token_requestor_name, token_score, token_type |
| digital_wallet_token.token_service_provider.correlation_id string Optional | For Mastercard only. Unique value representing a tokenization request. Allowable Values: Existing correlation identifier |
| digital_wallet_token.token_service_provider.pan_reference_id string Optional | Unique identifier of the digital wallet token primary account number (PAN) within the card network. Allowable Values: Existing PAN Reference ID |
| digital_wallet_token.token_service_provider.token_assurance_level string Optional | For Mastercard only. Represents the confidence level in the digital wallet token. Allowable Values: 0-99 |
| digital_wallet_token.token_service_provider.token_eligibility_decision string Optional | Digital wallet’s decision as to whether the digital wallet token should be provisioned. Allowable Values: DECISION_RED, DECISION_YELLOW, DECISION_GREEN |
| digital_wallet_token.token_service_provider.token_expiration string Optional | Expiration date of the digital wallet token. Allowable Values: Format: MMyy |
| digital_wallet_token.token_service_provider.token_pan string Optional | Primary account number (PAN) of the digital wallet token. Allowable Values: 16 char max |
| digital_wallet_token.token_service_provider.token_reference_id string Optional | Unique identifier of the digital wallet token within the card network. Allowable Values: Existing Token Reference ID |
| digital_wallet_token.token_service_provider.token_requestor_id string Optional | 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_PAYVisa - 40010030273 – APPLE_PAY- 40010075001 – ANDROID_PAY- 40010043095 – SAMSUNG_PAY- 40010075196 – MICROSOFT_PAY- 40010075338 – VISA_CHECKOUT- 40010075449 – FACEBOOK- 40010075839 – NETFLIX- 40010077056 – FITBIT_PAY- 40010069887 – GARMIN_PAYAllowable Values: 11 char max Example Values: - Mastercard – 50110030273, 50120834693, 50139059239 - Visa – 40010030273, 40010075001, 40010075338, 40010075449, 40010075839, 40010043095 |
| digital_wallet_token.token_service_provider.token_requestor_name string Optional | 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. Allowable Values: 255 char max Example Values: - Mastercard – APPLE_PAY, ANDROID_PAY, SAMSUNG_PAY- Visa – APPLE_PAY, ANDROID_PAY, SAMSUNG_PAY, MICROSOFT_PAY, VISA_CHECKOUT, FACEBOOK, NETFLIX, FITBIT_PAY, GARMIN_PAY |
| digital_wallet_token.token_service_provider.token_score string Optional | Token score assigned by the digital wallet. Allowable Values: 25 char max |
| digital_wallet_token.token_service_provider.token_type string Optional | Type of the digital wallet token. Allowable Values: MERCHANT_CARD_ON_FILE, DEVICE_SECURE_ELEMENT, DEVICE_CLOUD_BASED, ECOMMERCE_DIGITAL_WALLET |
| digital_wallet_token.transaction_device object Optional | 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. Allowable Values: binding_id, ip_address, location, phone_number |
| digital_wallet_token.transaction_device.binding_id string Optional | Unique identifier of the data component bound to the credential. Allowable Values: 48 char max |
| digital_wallet_token.transaction_device.ip_address string Optional | 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. Allowable Values: IP address format, 39 char max |
| digital_wallet_token.transaction_device.location string Optional | 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. Allowable Values: Latitude and longitude in DDD.DD/DDD.DD format. |
| digital_wallet_token.transaction_device.phone_number string Optional | 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. Allowable Values: 15 char max |
| digital_wallet_token.user object Optional | Contains information about a cardholder. Allowable Values: account_holder_group_token, active, address1, address2, authentication, birth_date, birth_place, business_token, city, company, corporate_card_holder, country, created_time, email, first_name, gender, honorific, id_card_expiration_date, id_card_number, identifications, ip_address, last_modified_time, last_name, metadata, middle_name, nationality, notes, parent_token, passport_expiration_date, passport_number, password, phone, postal_code, ssn, state, status, title, token, uses_parent_account, zip |
| digital_wallet_token.user.account_holder_group_token string Optional | Associates the specified account holder group with the cardholder. Allowable Values: 36 char max |
| digital_wallet_token.user.active boolean Optional | Specifies if the cardholder is in the ACTIVE state on the Marqeta platform.Allowable Values: true, false |
| digital_wallet_token.user.address1 string Optional | Cardholder’s address. Allowable Values: 255 char max |
| digital_wallet_token.user.address2 string Optional | Additional address information for the cardholder. Allowable Values: 255 char max |
| digital_wallet_token.user.authentication object Optional | Contains the cardholder’s email address and password information. Allowable Values: email_verified, email_verified_time, last_password_update_channel, last_password_update_time |
| digital_wallet_token.user.authentication.email_verified boolean Optional | Specifies whether the email address has been verified. Allowable Values: true, false |
| digital_wallet_token.user.authentication.email_verified_time datetime Optional | Date and time when the email address was verified. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| digital_wallet_token.user.authentication.last_password_update_channel string Optional | Specifies the channel through which the password was last changed. Allowable Values: USER_CHANGE, USER_RESET |
| digital_wallet_token.user.authentication.last_password_update_time datetime Optional | Date and time when the password was last changed. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| digital_wallet_token.user.birth_date string Optional | Cardholder’s date of birth. Allowable Values: Format: yyyy-MM-dd |
| digital_wallet_token.user.birth_place string Optional | Country where the cardholder was born. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is US.The ISO maintains the full list of ISO-3166 country codes. |
| digital_wallet_token.user.business_token string Optional | Unique identifier of the business resource. Allowable Values: Existing business resource token |
| digital_wallet_token.user.city string Optional | City where the cardholder resides. Allowable Values: 40 char max |
| digital_wallet_token.user.company string Optional | Company name. Allowable Values: 255 char max |
| digital_wallet_token.user.corporate_card_holder boolean Optional | Specifies if the cardholder holds a corporate card. Allowable Values: true, false |
| digital_wallet_token.user.country string Optional | Country where the cardholder resides. Allowable Values: 40 char max |
| digital_wallet_token.user.created_time datetime Required | Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| digital_wallet_token.user.email string Optional | Valid email address of the cardholder. Allowable Values: 1–255 chars |
| digital_wallet_token.user.first_name string Optional | Cardholder’s first name. Allowable Values: 40 char max |
| digital_wallet_token.user.gender string Optional | Gender of the cardholder. Allowable Values: F, M |
| digital_wallet_token.user.honorific string Optional | Cardholder’s title or prefix: Dr., Miss, Mr., Ms., and so on. Allowable Values: 10 char max |
| digital_wallet_token.user.id_card_expiration_date string Optional | Expiration date of the cardholder’s identification. Allowable Values: Format: yyyy-MM-dd |
| digital_wallet_token.user.id_card_number string Optional | Cardholder’s identification card number. Allowable Values: 255 char max |
| digital_wallet_token.user.identifications array of objects Optional | One or more objects containing identifications associated with the cardholder. Allowable Values: Valid array of one or more identifications objects |
| digital_wallet_token.user.identifications[].expiration_date string Optional | Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
| digital_wallet_token.user.identifications[].type string Optional | Type of identification. Allowable Values: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE |
| digital_wallet_token.user.identifications[].value string Optional | Number associated with the identification. Allowable Values: 255 char max |
| digital_wallet_token.user.ip_address string Optional | Cardholder’s IP address. Allowable Values: 39 char max |
| digital_wallet_token.user.last_modified_time datetime Required | Date and time when the resource was last updated, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| digital_wallet_token.user.last_name string Optional | Cardholder’s last name. Allowable Values: 40 char max |
| digital_wallet_token.user.metadata object Optional | Associates any additional metadata you provide with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format “my_name_1”: “my_value_1” |
| digital_wallet_token.user.middle_name string Optional | Cardholder’s middle name. Allowable Values: 40 char max |
| digital_wallet_token.user.nationality string Optional | Cardholder’s nationality. Allowable Values: 255 char max |
| digital_wallet_token.user.notes string Optional | Any additional information pertaining to the cardholder. Allowable Values: 255 char max |
| digital_wallet_token.user.parent_token string Optional | Unique identifier of the parent user or business resource. Allowable Values: 1–36 chars |
| digital_wallet_token.user.passport_expiration_date string Optional | Expiration date of the cardholder’s passport. Allowable Values: Format: yyyy-MM-dd |
| digital_wallet_token.user.passport_number string Optional | Cardholder’s passport number. Allowable Values: 40 char max |
| digital_wallet_token.user.password string Optional | Password to the cardholder’s user account on the Marqeta platform. Allowable Values: 1–255 chars |
| digital_wallet_token.user.phone string Optional | Cardholder’s telephone number. Allowable Values: 255 char max |
| digital_wallet_token.user.postal_code string Optional | Postal code of the cardholder’s address. Allowable Values: 10 char max |
| digital_wallet_token.user.ssn string Optional | Cardholder’s Social Security Number (SSN). Allowable Values: Nine digits only, no delimiters. |
| digital_wallet_token.user.state string Optional | State or province where the cardholder resides. Allowable Values: 2 char max |
| digital_wallet_token.user.status string Optional | Specifies the status of the cardholder on the Marqeta platform. Allowable Values: UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED |
| digital_wallet_token.user.title string Optional | Professional title of the cardholder, such as Chief Comptroller. Allowable Values: 255 char max |
| digital_wallet_token.user.token string Optional | Unique identifier of the cardholder. Allowable Values: 1–36 chars |
| digital_wallet_token.user.uses_parent_account boolean Optional | Indicates whether the child shares balances with the parent (true), or the child’s balances are independent of the parent (false).Allowable Values: true, false |
| digital_wallet_token.user.zip string Optional | United States ZIP code of the cardholder’s address. Allowable Values: 10 char max |
| digital_wallet_token.wallet_provider_profile object Optional | Contains information held and provided by the digital wallet provider. Allowable Values: account, device_score, pan_source, reason_code, recommendation_reasons, risk_assessment |
| digital_wallet_token.wallet_provider_profile.account object Optional | Contains information related to the cardholder and provided by the digital wallet provider. Allowable Values: email_address, id, score |
| digital_wallet_token.wallet_provider_profile.account.email_address string Optional | Digital wallet provider’s email address for the cardholder. Allowable Values: 255 char max |
| digital_wallet_token.wallet_provider_profile.account.id string Optional | Digital wallet provider’s identity number for the cardholder. Allowable Values: 20 char max |
| digital_wallet_token.wallet_provider_profile.account.score string Optional | Score from the digital wallet provider. Allowable Values: 50 char max |
| digital_wallet_token.wallet_provider_profile.device_score string Optional | Score from the device. Allowable Values: 50 char max |
| digital_wallet_token.wallet_provider_profile.pan_source string Optional | Source from which the digital wallet provider obtained the card primary account number (PAN). Allowable Values: KEY_ENTERED, ON_FILE, MOBILE_BANKING_APP |
| digital_wallet_token.wallet_provider_profile.reason_code string Optional | 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. Allowable Values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 0A, 0B, 0C, 0D, 0E, 0G |
| digital_wallet_token.wallet_provider_profile.recommendation_reasons array of strings Optional | Array of recommendation reasons from the digital wallet provider. Allowable Values: Valid array of one or more recommendation reasons |
| digital_wallet_token.wallet_provider_profile.risk_assessment object Optional | Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token. Allowable Values: score, version |
| digital_wallet_token.wallet_provider_profile.risk_assessment.score string Optional | Wallet provider’s decision as to whether the digital wallet token should be provisioned. Allowable Values: DECISION_RED, DECISION_YELLOW, DECISION_GREEN |
| digital_wallet_token.wallet_provider_profile.risk_assessment.version string Optional | Wallet provider’s risk assessment version. Allowable Values: Version information, as provided by the wallet provider |
| direct_deposit object Optional | Contains information about a direct deposit. Allowable Values: Existing direct_deposit object |
| direct_deposit.amount decimal Optional | Amount being debited or credited. Allowable Values: decimal Format: 0.00 |
| direct_deposit.business_token string Optional | The unique identifier of the business account holder. Allowable Values: Existing business token |
| direct_deposit.company_discretionary_data string Optional | Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max |
| direct_deposit.company_entry_description string Optional | Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max |
| direct_deposit.company_identification string Optional | Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max |
| direct_deposit.company_name string Optional | Name of the direct deposit originator. Allowable Values: 16 char max |
| direct_deposit.created_time datetime Optional | Date and time when the direct deposit account was created. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| direct_deposit.direct_deposit_account_token string Optional | The unique identifier of the direct deposit account. Allowable Values: Existing direct deposit account token |
| direct_deposit.individual_identification_number string Optional | Accounting number by which the recipient is known to the direct deposit originator. Allowable Values: 255 char max |
| direct_deposit.individual_name string Optional | Name of the direct deposit recipient. Allowable Values: 22 char max |
| direct_deposit.last_modified_time datetime Optional | Date and time when the direct deposit account was last modified. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| direct_deposit.settlement_date datetime Optional | Date and time when the credit or debit is applied. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| direct_deposit.standard_entry_class_code string Optional | Three-letter code identifying the type of entry. Allowable Values: ACK, ADV, ARC, ATX, BOC, CCD, CIE, COR, CTX, DNE, ENR, IAT, MTE, POP, POS, PPD, RCK, SHR, TEL, TRC, TRX, WEB, XCK |
| direct_deposit.state string Optional | Current status of the direct deposit record. Allowable Values: PENDING, APPLIED, REVERSED, REJECTED |
| direct_deposit.state_reason string Optional | Explanation for why the direct deposit record is in the current state. Allowable Values: 255 char max |
| direct_deposit.state_reason_code string Optional | Standard code describing the reason for the current state. Allowable Values: See ACHR return reason codes for the full list of supported codes and the grace period associated with each. |
| direct_deposit.token string Optional | The unique identifier of the direct deposit record. Allowable Values: Existing direct deposit record token |
| direct_deposit.type string Optional | Determines whether funds are being debited from or credited to the account. Allowable Values: CREDIT, DEBIT |
| direct_deposit.user_token string Optional | The unique identifier of the user account holder. Allowable Values: Existing user token |
| dispute object Optional | Contains information about a disputed transaction. Allowable Values: Existing dispute object |
| dispute.case_management_identifier string Optional | The unique identifier of the dispute case. Allowable Values: 255 char max |
| dispute.reason string Optional | The reason for the dispute. Allowable Values: 255 char max |
| duration integer Optional | Duration of the transaction on Marqeta’s servers, in milliseconds. Allowable Values: Any integer |
| enhanced_data_token string Optional | The enhanced commercial card data token for the transaction. Allowable Values: 255 char max |
| estimated_authorization boolean Optional | 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. Allowable Values: true, false |
| fee object Optional | Contains details about the fee. Allowable Values: amount, created_time, currency_code, last_modified_time, name, tags, token |
| fee.amount decimal Required | Amount of the fee. Allowable Values: decimal Format: 0.00 |
| fee.created_time datetime Required | Date and time when the fees object was created, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| fee.currency_code string Required | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| fee.last_modified_time datetime Required | Date and time when the fees object was last modified, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| fee.name string Required | Name of the fee. Allowable Values: 50 char max |
| fee.tags string Optional | Descriptive metadata about the fee. Allowable Values: 255 char max |
| fee.token string Required | Unique identifier of the fees object.Allowable Values: Existing fees object token |
| fee_transfer object Optional | Contains information about a fee charge, including the amount, currency code, and user or business token. Allowable Values: business_token, created_time, fees, tags, token, user_token |
| fee_transfer.business_token string Required | Specifies the business account holder to which the fee applies. Allowable Values: 1–36 chars |
| fee_transfer.created_time datetime Required | Date and time when the fee_charge object was created, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| fee_transfer.fees array of objects Required | Contains attributes that define characteristics of one or more fees. Allowable Values: Array of existing fees objects |
| fee_transfer.fees[].fee object Required | Contains details about the fee. Allowable Values: amount, created_time, currency_code, last_modified_time, name, tags, token |
| fee_transfer.fees[].fee.amount decimal Required | Amount of the fee. Allowable Values: decimal Format: 0.00 |
| fee_transfer.fees[].fee.created_time datetime Required | Date and time when the fees object was created, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| fee_transfer.fees[].fee.currency_code string Required | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| fee_transfer.fees[].fee.last_modified_time datetime Required | Date and time when the fees object was last modified, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| fee_transfer.fees[].fee.name string Required | Name of the fee. Allowable Values: 50 char max |
| fee_transfer.fees[].fee.tags string Optional | Descriptive metadata about the fee. Allowable Values: 255 char max |
| fee_transfer.fees[].fee.token string Required | Unique identifier of the fees object.Allowable Values: Existing fees object token |
| fee_transfer.fees[].memo string Optional | Additional text describing the fee. Allowable Values: 1–255 chars |
| fee_transfer.fees[].overrideAmount decimal Optional | Dynamic fee amount that overrides the fee.amount field value.Allowable Values: decimal Format: 0.00 |
| fee_transfer.fees[].tags string Optional | Descriptive metadata about the fee. Allowable Values: 255 char max |
| fee_transfer.fees[].token string Required | Unique identifier of the fee. Allowable Values: 1–36 chars |
| fee_transfer.fees[].transaction_token string Required | Unique identifier of the fee transaction. Allowable Values: 36 char max |
| fee_transfer.tags string Optional | Metadata about the fee charge. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| fee_transfer.token string Required | Unique identifier of the fee transfer. Allowable Values: 1–36 chars |
| fee_transfer.user_token string Required | Specifies the user account holder to which the fee applies. Allowable Values: 1–36 chars |
| fees array of objects Optional | List of fees associated with the transaction. This array is returned if it exists in the resource. Allowable Values: Array of existing fees objects |
| fees[].amount decimal Optional | Amount of the network fee. Allowable Values: decimal Format: 0.00 |
| fees[].credit_debit string Optional | Indicates whether the fee is a credit or a debit. - C indicates a credit - D indicates a debit Allowable Values: C, D |
| fees[].currency string Optional | Type of currency used when assessing a CROSS_BORDER_ISSUER_FEE or INTERCHANGE_FEE on Mastercard multi-currency transactions. Three-digit ISO 4217 currency code.Allowable Values: Any currency code allowed by your program |
| fees[].type string Optional | Type of fee assessed by the card network. Allowable Values: ISSUER_FEE, SWITCH_FEE, PINDEBIT_ASSOC_FEE, ACQUIRER_FEE, INTERCHANGE_FEE, CUR_CONV_CARDHOLDER_FEE, CUR_CONV_ISSUER_FEE, CROSS_BORDER_ISSUER_FEE |
| fleet_data object Optional | Contains details about fleet program transactions. Allowable Values: purchase_type, prompt_data |
| fleet_data.purchase_type string Optional | If provided by the network, indicates whether the purchase contains items for fuel, non-fuel, or both. Allowable Values: fuel, non-fuel, fuel_and_non_fuel |
| fleet_data.prompt_data object Optional | If card product is configured for prompting, contains prompt data entered at the point of sale. Allowable Values: driver_number, vehicle_number, odometer |
| fleet_data.prompt_data.driver_number string Optional | Driver number entered at the point of sale. Allowable Values: 255 char max |
| fleet_data.prompt_data.vehicle_number string Optional | Vehicle number entered at the point of sale. Allowable Values: 255 char max |
| fleet_data.prompt_data.odometer string Optional | Fleet vehicle odometer reading entered at the point of sale. Allowable Values: 255 char max |
| flex object Optional | Contains information about a Flexible Credential transaction. Allowable Values: action, eligible, eligible_products, secondary_credential_identifier, selected_product |
| flex.action string Optional | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).Allowable Values: inquiry, advice |
| flex.eligible string Optional | Indicates whether or not the transaction is eligible for Flexible Credential transactions. Allowable Values: true, false |
| flex.eligible_products array of strings Optional | 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.Allowable Values: DEBIT, LOAN |
| flex.secondary_credential_identifier string Optional | Identifies the secondary credential used in the transaction, if applicable. Allowable Values: 255 char max |
| flex.selected_product string Optional | Indicates the eligible product that was used in the transaction. Allowable Values: DEBIT, LOAN |
| fraud object Optional | Contains one or more fraud determinations by the card network that apply to either the transaction or the cardholder’s account. Allowable Values: issuer_processor, network_fraud_view, network_account_intelligence_score |
| fraud.issuer_processor object Optional | Contains one or more fraud determinations by the card network that apply to either the transaction or the cardholder’s account. Allowable Values: recommended_action, risk_level, riskcontrol_tags, rule_violations, score |
| fraud.issuer_processor.recommended_action string Optional | The action recommended based on the fraud score. Allowable Values: APPROVE, DECLINE, NOT_PERFORMED |
| fraud.issuer_processor.risk_level string Optional | The fraud rating, or level of risk associated with the transaction. Allowable Values: high, low |
| fraud.issuer_processor.riskcontrol_tags array of objects Optional | The RiskControl tags that were triggered by the transaction. Allowable Values: rule_name, tag. values |
| fraud.issuer_processor.riskcontrol_tags[].rule_name string Optional | Name of the rule, as defined in the Real-Time Decisioning dashboard, that was triggered. Allowable Values: 255 char max |
| fraud.issuer_processor.riskcontrol_tags[].tag string Optional | Tag name defined in the rule definition in the Real-Time Decisioning dashboard. Allowable Values: 255 char max |
| fraud.issuer_processor.riskcontrol_tags[].values array of strings Optional | Value associated with the tag. Allowable Values: 255 char max |
| fraud.issuer_processor.rule_violations array of strings Optional | The rules violated by the transaction. Allowable Values: Valid array of rule_violations strings |
| fraud.issuer_processor.score integer Optional | The risk score generated by RiskControl. This is either the Mastercard Decision Intelligence or Visa Advance Authorization transaction risk score. Allowable Values: 0-99 |
| fraud.issuer_processor.triggered_rules array of objects Optional | Provides a list of rules triggered by a fraud event, along with the information on tags and rule characteristics. Allowable Values: alert, entity_type, rule_name, suppress_alert, tags |
| fraud.issuer_processor.triggered_rules[].alert boolean Optional | Indicates if the rule triggered an alert. Allowable Values: true, false |
| fraud.issuer_processor.triggered_rules[].entity_type string Optional | The entity type where the triggered rule was defined. Allowable Values: Valid entity type |
| fraud.issuer_processor.triggered_rules[].rule_name string Optional | Name of the rule, as defined in the Real-Time Decisioning dashboard that was triggered. Allowable Values: 255 char max |
| fraud.issuer_processor.triggered_rules[].suppress_alert boolean Optional | Indicates if the triggered rule has suppress_alert in the definition.Allowable Values: true, false |
| fraud.issuer_processor.triggered_rules[].tags array of objects Optional | All the tags defined in the triggered rule. Allowable Values: name, value |
| fraud.network object Optional | Contains network-provided information about fraud determinations. Allowable Values: account_risk_score, account_risk_score_reason_code, transaction_risk_score, transaction_risk_score_reason_code, transaction_risk_score_reason_description |
| fraud.network.account_risk_score string Optional | (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. Allowable Values: 1-9 |
| fraud.network.account_risk_score_reason_code string Optional | (Visa only) Unique code that describes the main driver of the account_risk_score.Allowable Values: 255 char max |
| fraud.network.card_not_present_transaction_risk_score string Optional | (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. Allowable Values: Two-digit number between 01 and 99 |
| fraud.network.dii_score string Optional | Mastercard Digital Identity Insights risk score, where 0 indicates the lowest risk and 9 indicates the highest risk.Allowable Values: One-digit number between 0 and 9 |
| fraud.network.dii_score_reason_code string Optional | Mastercard Digital Identity Insights risk score reason code, where AA indicates the lowest risk, and ZZ indicates the highest risk.Allowable Values: Reason code, as provided by the Mastercard network |
| fraud.network.transaction_account_attack_intelligence_score string Optional | (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. Allowable Values: Two-digit number between 00 and 99 |
| fraud.network.transaction_risk_score integer Optional | Network-provided risk score for the transaction. A higher score indicates higher risk. Useful for making authorization decisions. Allowable Values: Mastercard: 0-99 Visa: 1-99 Pulse: 1-99 |
| fraud.network.transaction_risk_score_reason_code string Optional | For Mastercard only. Unique code that describes the main driver of the transaction_risk_score.Allowable Values: 1-29 |
| fraud.network.transaction_risk_score_reason_description string Optional | For Mastercard only. Description of the transaction_risk_score_reason_code.Allowable Values: 255 char max |
| fraud.network_account_intelligence_score object Optional | Account intelligence score information, as provided by the Mastercard network. Allowable Values: name, service_type, value |
| fraud.network_account_intelligence_score.name string Optional | The name, as provided by the Mastercard network. Allowable Values: 255 char max |
| fraud.network_account_intelligence_score.service_type string Optional | The service type, as provided by the Mastercard network. Allowable Values: 255 char max |
| fraud.network_account_intelligence_score.value string Optional | The value, as provided by the Mastercard network. Allowable Values: 255 char max |
| from_account string Optional | Specifies the funding account type. Allowable Values: DEFAULT, OTHER, SAVINGS, CHECKING, CREDIT CARD, DEFERRED DEBIT, CHARGE, CREDIT LINE, CORPORATE, CREDIT FACILITY, UNIVERSAL, MONEY MARKET INVESTMENT, IRA INVESTMENT, EMPLOYEE BENEFIT, STORED VALUE, REVOLVING LOAN, MORTGAGE, INSTALLMENT LOAN ACCOUNT, REAL ESTATE LOAN, CHILD CARE BENEFIT, CASH BENEFIT, UNKNOWN, FOOD STAMP |
| gpa object Optional | Returns general purpose account (GPA) balances for a user or business. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| gpa.available_balance decimal Required | 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. Allowable Values: decimal Format: 0.00 |
| gpa.balances object Required | Contains GPA balance information, organized by currency code. Allowable Values: One or more balances objects |
| gpa.cached_balance decimal Required | Not currently in use. Allowable Values: Not applicable |
| gpa.credit_balance decimal Required | Not currently in use. Allowable Values: Not applicable |
| gpa.currency_code string Required | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| gpa.impacted_amount decimal Optional | Balance change based on the amount of the transaction. Allowable Values: decimal Format: 0.00 |
| gpa.last_updated_time datetime Required | Date and time when the resource was last updated, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa.ledger_balance decimal Required | 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. Allowable Values: decimal Format: 0.00 |
| gpa.pending_credits decimal Required | ACH loads that have been accepted, but for which the funding time has not yet elapsed. Allowable Values: decimal Format: 0.00 |
| gpa_order object Optional | Contains information about a GPA order, including fees, funding sources, and addresses. See GPA Orders for more information. Allowable Values: amount, business_token, created_time, currency_code, fees, funding, funding_source_address_token, funding_source_token, gateway_message, gateway_token, jit_funding, last_modified_time, memo, response, state, tags, token, transaction_token, user_token |
| gpa_order.amount decimal Required | Amount funded. Allowable Values: decimal Format: 0.00 |
| gpa_order.business_token string Optional | Unique identifier of the business. This field is returned if it exists in the resource. Allowable Values: Existing business_token |
| gpa_order.created_time datetime Required | Date and time when the GPA order was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order.currency_code string Required | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| gpa_order.fees array of objects Optional | List of fees associated with the funding transaction. This array is returned if it exists in the resource. Allowable Values: Valid array of one or more fees objects |
| gpa_order.fees[].fee object Required | Contains details about the fee. Allowable Values: amount, created_time, currency_code, last_modified_time, name, tags, token |
| gpa_order.fees[].fee.amount decimal Required | Amount of the fee. Allowable Values: decimal Format: 0.00 |
| gpa_order.fees[].fee.created_time datetime Required | Date and time when the fees object was created, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order.fees[].fee.currency_code string Required | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| gpa_order.fees[].fee.last_modified_time datetime Required | Date and time when the fees object was last modified, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order.fees[].fee.name string Required | Name of the fee. Allowable Values: 50 char max |
| gpa_order.fees[].fee.tags string Optional | Descriptive metadata about the fee. Allowable Values: 255 char max |
| gpa_order.fees[].fee.token string Required | Unique identifier of the fees object.Allowable Values: Existing fees object token |
| gpa_order.fees[].memo string Optional | Additional text describing the fee. Allowable Values: 1–255 chars |
| gpa_order.fees[].overrideAmount decimal Optional | Dynamic fee amount that overrides the fee.amount field value.Allowable Values: decimal Format: 0.00 |
| gpa_order.fees[].tags string Optional | Descriptive metadata about the fee. Allowable Values: 255 char max |
| gpa_order.fees[].token string Required | Unique identifier of the fee. Allowable Values: 1–36 chars |
| gpa_order.fees[].transaction_token string Required | Unique identifier of the fee transaction. Allowable Values: 36 char max |
| gpa_order.funding object Required | Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: amount, gateway_log, source, source_address |
| gpa_order.funding.amount decimal Optional | Amount of funds loaded into the GPA. Allowable Values: decimal Format: 0.00 |
| gpa_order.funding.gateway_log object Optional | Contains information from the JIT Funding gateway in response to a funding request. Allowable Values: duration, message, order_number, response, timed_out, transaction_id |
| gpa_order.funding.gateway_log.duration integer Optional | Length of time in milliseconds that the gateway took to respond to a funding request. Allowable Values: Any integer |
| gpa_order.funding.gateway_log.message string Required | Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out. Allowable Values: Approved or completed successfully, Declined by gateway, Operation timeout |
| gpa_order.funding.gateway_log.order_number string Required | Customer order number, same value as transaction.token.Allowable Values: Existing transaction.token value |
| gpa_order.funding.gateway_log.response object Optional | Contains information from the gateway in response to a funding request. Allowable Values: code, data |
| gpa_order.funding.gateway_log.response.code string Required | Code received from the gateway. Allowable Values: 255 char max |
| gpa_order.funding.gateway_log.response.data object Optional | Contains the gateway’s information about the JIT Funding transaction. Allowable Values: jit_funding |
| gpa_order.funding.gateway_log.response.data.jit_funding object Required | 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. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| gpa_order.funding.gateway_log.response.data.jit_funding.acting_user_token string Optional | User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification object Optional | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway object Optional | 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. Allowable Values: on_file, response |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer object Optional | 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. Allowable Values: on_file, response |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.jit_account_name_verification object Optional | 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.Allowable Values: gateway, issuer, request |
| gpa_order.funding.gateway_log.response.data.jit_funding.jit_account_name_verification.gateway object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order.funding.gateway_log.response.data.jit_funding.jit_account_name_verification.issuer object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order.funding.gateway_log.response.data.jit_funding.jit_account_name_verification.request object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order.funding.gateway_log.response.data.jit_funding.amount decimal Required | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| gpa_order.funding.gateway_log.response.data.jit_funding.balances object Optional | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| gpa_order.funding.gateway_log.response.data.jit_funding.business_token string Optional | Holder of the business account that was funded. Allowable Values: 36 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.decline_reason string Optional | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| gpa_order.funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens array of strings Optional | 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. Allowable Values: Existing incremental authorization JIT Funding tokens |
| gpa_order.funding.gateway_log.response.data.jit_funding.memo string Optional | Additional information that describes the JIT Funding transaction. Allowable Values: 99 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.method string Required | JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values: pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| gpa_order.funding.gateway_log.response.data.jit_funding.original_jit_funding_token string Optional | 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. Allowable Values: 36 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.tags string Optional | Customer-defined tags related to the JIT Funding transaction. Allowable Values: 255 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.token string Required | 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.Allowable Values: 36 char max |
| gpa_order.funding.gateway_log.response.data.jit_funding.user_token string Required | Holder of the user account that was funded. Allowable Values: 36 char max |
| gpa_order.funding.gateway_log.response.data.flex object Optional | Contains information about a Flexible Credential transaction. Allowable Values: action, eligible, eligible_products, secondary_credential_identifier, selected_product |
| gpa_order.funding.gateway_log.response.data.flex.action string Optional | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).Allowable Values: inquiry, advice |
| gpa_order.funding.gateway_log.response.data.flex.eligible string Optional | Indicates whether or not the transaction is eligible for Flexible Credential transactions. Allowable Values: true, false |
| gpa_order.funding.gateway_log.response.data.flex.eligible_products array of strings Optional | 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.Allowable Values: DEBIT, LOAN |
| gpa_order.funding.gateway_log.response.data.flex.secondary_credential_identifier string Optional | Identifies the secondary credential used in the transaction, if applicable. Allowable Values: 255 char max |
| gpa_order.funding.gateway_log.response.data.flex.selected_product string Optional | Indicates the eligible product that was used in the transaction. Allowable Values: DEBIT, LOAN |
| gpa_order.funding.gateway_log.timed_out boolean Optional | Whether the gateway sent a response (true) or timed out (false).Allowable Values: true, false |
| gpa_order.funding.gateway_log.transaction_id string Required | Customer-defined identifier for the transaction. Allowable Values: 255 char max |
| gpa_order.funding.source object Required | Contains funding source information for the transaction, including the funding type and time. Allowable Values: active, created_time, is_default_account, last_modified_time, token, type |
| gpa_order.funding.source.active boolean Required | Whether the funding source is active. Allowable Values: true, false |
| gpa_order.funding.source.created_time datetime Required | Date and time when the funding source was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order.funding.source.is_default_account boolean Required | Whether the GPA order unload’s funding source is the default funding account. Allowable Values: true, false |
| gpa_order.funding.source.last_modified_time datetime Required | Date and time when the funding source was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order.funding.source.token string Required | Unique identifier of the funding source. Allowable Values: Format: UUID |
| gpa_order.funding.source.type string Required | Funding type of the funding source. Allowable Values: ach, paymentcard |
| gpa_order.funding.source_address object Optional | Contains information about the billing address of the funding source. Allowable Values: active, address_1, address_2, business_token, city, country, created_time, first_name, is_default_address, last_modified_time, last_name, phone, postal_code, state, token, user_token, zip |
| gpa_order.funding.source_address.active boolean Optional | Whether the address is active. Allowable Values: true, false |
| gpa_order.funding.source_address.address_1 string Required | Street address of the funding source. Allowable Values: 255 char max |
| gpa_order.funding.source_address.address_2 string Optional | Additional address information for the funding source. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| gpa_order.funding.source_address.business_token string Optional | Unique identifier of the business account holder associated with the address. This field is returned if it exists in the resource. Allowable Values: 1–36 chars |
| gpa_order.funding.source_address.city string Required | City of the funding source. Allowable Values: 40 char max |
| gpa_order.funding.source_address.country string Required | Country of the funding source. Allowable Values: 1–40 chars |
| gpa_order.funding.source_address.created_time datetime Required | Date and time when the address was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order.funding.source_address.first_name string Required | First name of the account holder associated with the funding source. Allowable Values: 40 char max |
| gpa_order.funding.source_address.is_default_address boolean Optional | Whether this address is the default address used by the funding source. Allowable Values: true, false |
| gpa_order.funding.source_address.last_modified_time datetime Required | Date and time when the address was last modified, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order.funding.source_address.last_name string Required | Last name of the account holder associated with the funding source. Allowable Values: 40 char max |
| gpa_order.funding.source_address.phone string Optional | Phone number of the funding source. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| gpa_order.funding.source_address.postal_code string Required | Postal code of the funding source. Allowable Values: 10 char max |
| gpa_order.funding.source_address.state string Required | Two-character state, provincial, or territorial abbreviation. For the complete list, see Valid state, provincial, territorial, and federal abbreviations. Allowable Values: 2 char max |
| gpa_order.funding.source_address.token string Required | Unique identifier of the funding_source_address object.Allowable Values: 1–36 chars |
| gpa_order.funding.source_address.user_token string Optional | Unique identifier of the user account holder associated with the address. This field is returned if it exists in the resource. Allowable Values: 1–36 chars |
| gpa_order.funding.source_address.zip string Required | United States ZIP code of the funding source. Allowable Values: 10 char max |
| gpa_order.funding_source_address_token string Optional | Unique identifier of the funding source address to use for this order. Allowable Values: Existing funding_source_address token |
| gpa_order.funding_source_token string Required | Unique identifier of the funding source to use for this order. Allowable Values: Existing funding_source token |
| gpa_order.gateway_message string Optional | 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. Allowable Values: Approved or completed successfully, Declined by gateway, Operation timeout |
| gpa_order.gateway_token integer Optional | Unique identifier of the JIT Funding request and response. This field is returned if it exists in the resource. Allowable Values: Existing gateway_token |
| gpa_order.jit_funding object Optional | 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. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| gpa_order.jit_funding.acting_user_token string Optional | User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max |
| gpa_order.jit_funding.address_verification object Optional | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| gpa_order.jit_funding.address_verification.gateway object Optional | 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. Allowable Values: on_file, response |
| gpa_order.jit_funding.address_verification.gateway.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order.jit_funding.address_verification.gateway.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order.jit_funding.address_verification.gateway.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order.jit_funding.address_verification.gateway.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order.jit_funding.address_verification.gateway.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| gpa_order.jit_funding.address_verification.gateway.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| gpa_order.jit_funding.address_verification.gateway.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| gpa_order.jit_funding.address_verification.gateway.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| gpa_order.jit_funding.address_verification.issuer object Optional | 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. Allowable Values: on_file, response |
| gpa_order.jit_funding.address_verification.issuer.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order.jit_funding.address_verification.issuer.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order.jit_funding.address_verification.issuer.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order.jit_funding.address_verification.issuer.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order.jit_funding.address_verification.issuer.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| gpa_order.jit_funding.address_verification.issuer.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| gpa_order.jit_funding.address_verification.issuer.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| gpa_order.jit_funding.address_verification.issuer.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| gpa_order.jit_funding.address_verification.request object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order.jit_funding.address_verification.request.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order.jit_funding.address_verification.request.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order.jit_funding.address_verification.request.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order.jit_funding.jit_account_name_verification object Optional | 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.Allowable Values: gateway, issuer, request |
| gpa_order.jit_funding.jit_account_name_verification.gateway object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order.jit_funding.jit_account_name_verification.issuer object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order.jit_funding.jit_account_name_verification.request object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order.jit_funding.amount decimal Required | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| gpa_order.jit_funding.balances object Optional | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| gpa_order.jit_funding.business_token string Optional | Holder of the business account that was funded. Allowable Values: 36 char max |
| gpa_order.jit_funding.decline_reason string Optional | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| gpa_order.jit_funding.incremental_authorization_jit_funding_tokens array of strings Optional | 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. Allowable Values: Existing incremental authorization JIT Funding tokens |
| gpa_order.jit_funding.memo string Optional | Additional information that describes the JIT Funding transaction. Allowable Values: 99 char max |
| gpa_order.jit_funding.method string Required | JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values: pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| gpa_order.jit_funding.original_jit_funding_token string Optional | 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. Allowable Values: 36 char max |
| gpa_order.jit_funding.tags string Optional | Customer-defined tags related to the JIT Funding transaction. Allowable Values: 255 char max |
| gpa_order.jit_funding.token string Required | 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.Allowable Values: 36 char max |
| gpa_order.jit_funding.user_token string Required | Holder of the user account that was funded. Allowable Values: 36 char max |
| gpa_order.last_modified_time datetime Required | Date and time when the GPA order was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order.memo string Optional | Additional descriptive text. This field is returned if it exists in the resource. Allowable Values: 99 char max |
| gpa_order.response object Required | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| gpa_order.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| gpa_order.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| gpa_order.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| gpa_order.state string Required | Current status of the funding transaction. Allowable Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR, REVERSED |
| gpa_order.tags string Optional | Comma-delimited list of tags describing the GPA order. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| gpa_order.token string Required | Unique identifier of the GPA order. Allowable Values: 36 char max |
| gpa_order.transaction_token string Required | Unique identifier of the transaction being funded. Allowable Values: Format: UUID |
| gpa_order.user_token string Optional | Unique identifier of the user resource. This field is returned if it exists in the resource. Allowable Values: Existing user resource token |
| gpa_order_unload object Optional | Contains information about a GPA unload order. Allowable Values: amount, created_time, funding, funding_source_address_token, funding_source_token, jit_funding, last_modified_time, memo, original_order_token, response, state, tags, token, transaction_token |
| gpa_order_unload.amount decimal Required | Amount of funds returned to the funding source. Allowable Values: decimal Format: 0.00 |
| gpa_order_unload.created_time datetime Required | Date and time when the GPA unload order was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order_unload.funding object Required | Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: amount, gateway_log, source, source_address |
| gpa_order_unload.funding.amount decimal Optional | Amount of funds loaded into the GPA. Allowable Values: decimal Format: 0.00 |
| gpa_order_unload.funding.gateway_log object Optional | Contains information from the JIT Funding gateway in response to a funding request. Allowable Values: duration, message, order_number, response, timed_out, transaction_id |
| gpa_order_unload.funding.gateway_log.duration integer Optional | Length of time in milliseconds that the gateway took to respond to a funding request. Allowable Values: Any integer |
| gpa_order_unload.funding.gateway_log.message string Required | Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out. Allowable Values: Approved or completed successfully, Declined by gateway, Operation timeout |
| gpa_order_unload.funding.gateway_log.order_number string Required | Customer order number, same value as transaction.token.Allowable Values: Existing transaction.token value |
| gpa_order_unload.funding.gateway_log.response object Optional | Contains information from the gateway in response to a funding request. Allowable Values: code, data |
| gpa_order_unload.funding.gateway_log.response.code string Required | Code received from the gateway. Allowable Values: 255 char max |
| gpa_order_unload.funding.gateway_log.response.data object Optional | Contains the gateway’s information about the JIT Funding transaction. Allowable Values: jit_funding |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding object Required | 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. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.acting_user_token string Optional | User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification object Optional | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway object Optional | 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. Allowable Values: on_file, response |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer object Optional | 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. Allowable Values: on_file, response |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.request object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.request.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.request.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.jit_account_name_verification object Optional | 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.Allowable Values: gateway, issuer, request |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.jit_account_name_verification.gateway object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.jit_account_name_verification.issuer object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.jit_account_name_verification.request object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.amount decimal Required | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.balances object Optional | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.business_token string Optional | Holder of the business account that was funded. Allowable Values: 36 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.decline_reason string Optional | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens array of strings Optional | 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. Allowable Values: Existing incremental authorization JIT Funding tokens |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.memo string Optional | Additional information that describes the JIT Funding transaction. Allowable Values: 99 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.method string Required | JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values: pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.original_jit_funding_token string Optional | 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. Allowable Values: 36 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.tags string Optional | Customer-defined tags related to the JIT Funding transaction. Allowable Values: 255 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.token string Required | 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.Allowable Values: 36 char max |
| gpa_order_unload.funding.gateway_log.response.data.jit_funding.user_token string Required | Holder of the user account that was funded. Allowable Values: 36 char max |
| gpa_order_unload.funding.gateway_log.response.data.flex object Optional | Contains information about a Flexible Credential transaction. Allowable Values: action, eligible, eligible_products, secondary_credential_identifier, selected_product |
| gpa_order_unload.funding.gateway_log.response.data.flex.action string Optional | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).Allowable Values: inquiry, advice |
| gpa_order_unload.funding.gateway_log.response.data.flex.eligible string Optional | Indicates whether or not the transaction is eligible for Flexible Credential transactions. Allowable Values: true, false |
| gpa_order_unload.funding.gateway_log.response.data.flex.eligible_products array of strings Optional | 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.Allowable Values: DEBIT, LOAN |
| gpa_order_unload.funding.gateway_log.response.data.flex.secondary_credential_identifier string Optional | Identifies the secondary credential used in the transaction, if applicable. Allowable Values: 255 char max |
| gpa_order_unload.funding.gateway_log.response.data.flex.selected_product string Optional | Indicates the eligible product that was used in the transaction. Allowable Values: DEBIT, LOAN |
| gpa_order_unload.funding.gateway_log.timed_out boolean Optional | Whether the gateway sent a response (true) or timed out (false).Allowable Values: true, false |
| gpa_order_unload.funding.gateway_log.transaction_id string Required | Customer-defined identifier for the transaction. Allowable Values: 255 char max |
| gpa_order_unload.funding.source object Required | Contains funding source information for the transaction, including the funding type and time. Allowable Values: active, created_time, is_default_account, last_modified_time, token, type |
| gpa_order_unload.funding.source.active boolean Required | Whether the funding source is active. Allowable Values: true, false |
| gpa_order_unload.funding.source.created_time datetime Required | Date and time when the funding source was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order_unload.funding.source.is_default_account boolean Required | Whether the GPA order unload’s funding source is the default funding account. Allowable Values: true, false |
| gpa_order_unload.funding.source.last_modified_time datetime Required | Date and time when the funding source was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order_unload.funding.source.token string Required | Unique identifier of the funding source. Allowable Values: Format: UUID |
| gpa_order_unload.funding.source.type string Required | Funding type of the funding source. Allowable Values: ach, paymentcard |
| gpa_order_unload.funding.source_address object Optional | Contains information about the billing address of the funding source. Allowable Values: active, address_1, address_2, business_token, city, country, created_time, first_name, is_default_address, last_modified_time, last_name, phone, postal_code, state, token, user_token, zip |
| gpa_order_unload.funding.source_address.active boolean Optional | Whether the address is active. Allowable Values: true, false |
| gpa_order_unload.funding.source_address.address_1 string Required | Street address of the funding source. Allowable Values: 255 char max |
| gpa_order_unload.funding.source_address.address_2 string Optional | Additional address information for the funding source. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| gpa_order_unload.funding.source_address.business_token string Optional | Unique identifier of the business account holder associated with the address. This field is returned if it exists in the resource. Allowable Values: 1–36 chars |
| gpa_order_unload.funding.source_address.city string Required | City of the funding source. Allowable Values: 40 char max |
| gpa_order_unload.funding.source_address.country string Required | Country of the funding source. Allowable Values: 1–40 chars |
| gpa_order_unload.funding.source_address.created_time datetime Required | Date and time when the address was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order_unload.funding.source_address.first_name string Required | First name of the account holder associated with the funding source. Allowable Values: 40 char max |
| gpa_order_unload.funding.source_address.is_default_address boolean Optional | Whether this address is the default address used by the funding source. Allowable Values: true, false |
| gpa_order_unload.funding.source_address.last_modified_time datetime Required | Date and time when the address was last modified, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order_unload.funding.source_address.last_name string Required | Last name of the account holder associated with the funding source. Allowable Values: 40 char max |
| gpa_order_unload.funding.source_address.phone string Optional | Phone number of the funding source. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| gpa_order_unload.funding.source_address.postal_code string Required | Postal code of the funding source. Allowable Values: 10 char max |
| gpa_order_unload.funding.source_address.state string Required | Two-character state, provincial, or territorial abbreviation. For the complete list, see Valid state, provincial, territorial, and federal abbreviations. Allowable Values: 2 char max |
| gpa_order_unload.funding.source_address.token string Required | Unique identifier of the funding_source_address object.Allowable Values: 1–36 chars |
| gpa_order_unload.funding.source_address.user_token string Optional | Unique identifier of the user account holder associated with the address. This field is returned if it exists in the resource. Allowable Values: 1–36 chars |
| gpa_order_unload.funding.source_address.zip string Required | United States ZIP code of the funding source. Allowable Values: 10 char max |
| gpa_order_unload.funding_source_address_token string Optional | Identifies the funding source used for this order. Allowable Values: Existing funding_source_address token. |
| gpa_order_unload.funding_source_token string Required | Identifies the funding source used for this order. Allowable Values: Existing funding_source token |
| gpa_order_unload.jit_funding object Optional | 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. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| gpa_order_unload.jit_funding.acting_user_token string Optional | User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max |
| gpa_order_unload.jit_funding.address_verification object Optional | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| gpa_order_unload.jit_funding.address_verification.gateway object Optional | 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. Allowable Values: on_file, response |
| gpa_order_unload.jit_funding.address_verification.gateway.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order_unload.jit_funding.address_verification.gateway.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order_unload.jit_funding.address_verification.gateway.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order_unload.jit_funding.address_verification.gateway.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order_unload.jit_funding.address_verification.gateway.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| gpa_order_unload.jit_funding.address_verification.gateway.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| gpa_order_unload.jit_funding.address_verification.gateway.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| gpa_order_unload.jit_funding.address_verification.gateway.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| gpa_order_unload.jit_funding.address_verification.issuer object Optional | 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. Allowable Values: on_file, response |
| gpa_order_unload.jit_funding.address_verification.issuer.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order_unload.jit_funding.address_verification.issuer.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order_unload.jit_funding.address_verification.issuer.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order_unload.jit_funding.address_verification.issuer.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order_unload.jit_funding.address_verification.issuer.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| gpa_order_unload.jit_funding.address_verification.issuer.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| gpa_order_unload.jit_funding.address_verification.issuer.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| gpa_order_unload.jit_funding.address_verification.issuer.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| gpa_order_unload.jit_funding.address_verification.request object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| gpa_order_unload.jit_funding.address_verification.request.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| gpa_order_unload.jit_funding.address_verification.request.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| gpa_order_unload.jit_funding.address_verification.request.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| gpa_order_unload.jit_funding.jit_account_name_verification object Optional | 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.Allowable Values: gateway, issuer, request |
| gpa_order_unload.jit_funding.jit_account_name_verification.gateway object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order_unload.jit_funding.jit_account_name_verification.issuer object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order_unload.jit_funding.jit_account_name_verification.request object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| gpa_order_unload.jit_funding.amount decimal Required | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| gpa_order_unload.jit_funding.balances object Optional | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| gpa_order_unload.jit_funding.business_token string Optional | Holder of the business account that was funded. Allowable Values: 36 char max |
| gpa_order_unload.jit_funding.decline_reason string Optional | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| gpa_order_unload.jit_funding.incremental_authorization_jit_funding_tokens array of strings Optional | 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. Allowable Values: Existing incremental authorization JIT Funding tokens |
| gpa_order_unload.jit_funding.memo string Optional | Additional information that describes the JIT Funding transaction. Allowable Values: 99 char max |
| gpa_order_unload.jit_funding.method string Required | JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values: pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| gpa_order_unload.jit_funding.original_jit_funding_token string Optional | 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. Allowable Values: 36 char max |
| gpa_order_unload.jit_funding.tags string Optional | Customer-defined tags related to the JIT Funding transaction. Allowable Values: 255 char max |
| gpa_order_unload.jit_funding.token string Required | 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.Allowable Values: 36 char max |
| gpa_order_unload.jit_funding.user_token string Required | Holder of the user account that was funded. Allowable Values: 36 char max |
| gpa_order_unload.last_modified_time datetime Required | Date and time when the GPA unload order was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| gpa_order_unload.memo string Optional | Additional descriptive text. Allowable Values: 99 char max |
| gpa_order_unload.original_order_token string Optional | Identifies the original GPA order. Allowable Values: Existing GPA order token |
| gpa_order_unload.response object Required | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| gpa_order_unload.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| gpa_order_unload.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| gpa_order_unload.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| gpa_order_unload.state string Required | Current status of the GPA unload order. Allowable Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR, REVERSED |
| gpa_order_unload.tags string Optional | Comma-delimited list of tags describing the GPA order. Allowable Values: 255 char max |
| gpa_order_unload.token string Required | Unique identifier of the GPA unload order. Allowable Values: Existing GPA unload order token |
| gpa_order_unload.transaction_token string Required | Unique identifier of the transaction. Allowable Values: Format: UUID |
| identifier string Required | Sequential identifier of the transaction. Allowable Values: 255 char max |
| incremental_authorization_transaction_tokens array of strings Optional | An array of incremental authorization transaction tokens. Allowable Values: One or more transaction tokens |
| is_final_clearing boolean Optional | 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.Allowable Values: true, false |
| installment_data object Optional | Contains the installment plan identifier used by the Visa Transaction Matching Service for Issuers. Allowable Values: installment_plan_identifier |
| installment_data.installment_plan_identifier string Optional | (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. Allowable Values: 10-character identifier, as provided by the Visa network |
| is_preauthorization boolean Optional | Indicates if the transaction is a pre-authorization. Allowable Values: true, false |
| isaIndicator string Optional | The international service assessment indicator indicates if an ISA fee is applicable to the transaction. Allowable Values: MULTI_CURRENCY, SINGLE_CURRENCY, REBATE_CANCELLED, MULTI_CURRENCY_NON_US_COUNTRIES, SINGLE_CURRENCY_PAID_BY_ISSUER, NO_CHARGE_ASSESSED |
| issuer_interchange_amount decimal Optional | The amount of interchange charged by the card issuer. Allowable Values: decimal Format: 0.00 |
| issuer_payment_node string Optional | Unique identifier of the Marqeta platform server that received the transaction from the card network. Allowable Values: 255 char max |
| issuer_received_time string Optional | Date and time when the Marqeta platform received the transaction from the card network, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| local_transaction_date datetime Optional | 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. Allowable Values: datetime Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
| merchant_initiated_original_trace_id string Optional | 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. Allowable Values: 255 char max Example Value: MCC123ABC1105 |
| multi_clearing_sequence_count string Optional | 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.Allowable Values: The sequence count returned in the clearing record |
| multi_clearing_sequence_number string Optional | 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.Allowable Values: The sequence number returned in the clearing record |
| network string Optional | Indicates which card network was used to complete the transactions. Allowable Values: DISCOVER, MASTERCARD, PULSE, VISA, MARQETA |
| network_metadata object Optional | Contains network-related metadata for the transaction, including details about the card program and the card product. Returned if provided by the card network Allowable Values: product_id, program_id, spend_qualifier, surcharge_free_atm_network |
| network_metadata.product_id string Optional | 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. Allowable 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) |
| network_metadata.incoming_response_code string Optional | Network response code, as provided by the card network. For example, Visa response code 59 indicates suspected fraud.Allowable Values: Response code, as provided by the card network |
| network_metadata.outgoing_response_code string Optional | Network response code, as provided by Marqeta. For example, Visa response code 59 indicates suspected fraud.Allowable Values: Valid response code, as defined by the card network |
| network_metadata.program_id string Optional | 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.Allowable Values: 255 char max |
| network_metadata.spend_qualifier string Optional | Indicates whether or not the base spend-assessment threshold defined by the card network has been met. Allowable Values: 255 char max |
| network_metadata.surcharge_free_atm_network string Optional | Name of the surcharge-free ATM network used to complete the transaction. Allowable Values: AllPoint, MoneyPass, MoneyPass Pulse Select |
| network_metadata.network_funding_txn_type string Optional | Transaction type indicator provided by the card network for original credit and account funding transactions. Allowable Values: Literal value provided by the card network |
| network_reference_id string Optional | Network-assigned unique identifier of the transaction. Useful for settlement and reconciliation. Allowable Values: 255 char max |
| network_transaction_lifecycle_id string Optional | Transaction identifier, as provided by the card network. This identifier connects the original transaction to all subsequent activities throughout the transaction lifecycle. Allowable Values: 255 char max |
| original_credit object Optional | 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. Allowable Values: Existing original_credit object |
| original_credit.funding_source string Optional | Sender’s account from which the OCT draws funds. Allowable Values: CREDIT, DEBIT, PREPAID, DEPOSIT_ACCOUNT, CASH, MOBILE_MONEY_ACCOUNT, NON_VISA_CREDIT |
| original_credit.screening_score string Optional | 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. Allowable Values: 000-100 or 999 |
| original_credit.sender_account_type string Optional | The type of account from which the OCT draws funds. Allowable Values: OTHER, RTN_BANK_ACCOUNT, IBAN, CARD_ACCOUNT, EMAIL, PHONE_NUMBER, BANK_ACCOUNT_NUMBER_AND_BANK_IDENTIFICATION_CODE, WALLET_ID, SOCIAL_NETWORK_ID |
| original_credit.sender_address string Optional | Sender’s street address. Allowable Values: 255 char max |
| original_credit.sender_city string Optional | Sender’s city. Allowable Values: 255 char max |
| original_credit.sender_country string Optional | Sender’s country. Allowable Values: 255 char max |
| original_credit.sender_name string Optional | Full name of the sender. Allowable Values: 255 char max |
| original_credit.sender_state string Optional | Sender’s state. Allowable Values: 255 char max |
| original_credit.fast_funds_enabled boolean Optional | 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.Allowable Values: true, falseDefault value: false |
| original_credit.transaction_purpose string Optional | The purpose of the original credit transaction. Allowable Values: FAMILY_SUPPORT, REGULAR_LABOR_TRANSFERS, TRAVEL_AND_TOURISM, EDUCATION, MEDICAL_TREATMENT, EMERGENCY_NEED, SAVINGS, GIFTS, OTHER, SALARY, CROWD_LENDING, CRYPTO_CURRENCY, HIGH_RISK_SECURITIES, RECYCLING_DEPOSIT_RETURN, VALUE_ADDED_TAX_PAYMENT, TRANSFER_TO_ANOTHER_PERSON_OR_ORGANIZATION_IN_THE_SAME_STAGED_DIGITAL_WALLET, BOLETO_PAYMENT |
| original_credit.transaction_type string Optional | Type of original credit transaction. Allowable Values: 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 |
| original_transaction_token string Optional | Unique identifier of the original transaction in a series of related transactions. Allowable Values: Existing transaction token |
| payment_facilitator object Optional | Information about the payment facilitator of an account funding or original credit transaction. Allowable Values: city, country_code, postal_code, state, street_address |
| payment_facilitator.city string Optional | Payment facilitator’s city. Allowable Values: 255 char max |
| payment_facilitator.country_code string Optional | Payment facilitator’s country code. Allowable Values: Valid three-digit ISO 3166 country code |
| payment_facilitator.postal_code string Optional | Payment facilitator’s postal code. Allowable Values: 255 char max |
| payment_facilitator.state string Optional | Payment facilitator’s state location. Allowable Values: 255 char max |
| payment_facilitator.street_address string Optional | Payment facilitator’s street address. Allowable Values: 255 char max |
| peer_transfer object Optional | Contains information about an intra-account transfer, including sender and recipient tokens, transfer amount, and currency code. Allowable Values: amount, currency_code, memo, recipient_business_token, recipient_user_token, sender_business_token, sender_user_token, tags, token |
| peer_transfer.amount decimal Required | Amount of the transfer. Allowable Values: decimal Format: 0.00 |
| peer_transfer.currency_code string Required | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| peer_transfer.memo string Optional | Additional descriptive text about the intra-account transfer. Allowable Values: 1–99 chars |
| peer_transfer.recipient_business_token string Optional | Specifies the business account holder that receives funds. Allowable Values: 1–36 chars |
| peer_transfer.recipient_user_token string Optional | Specifies the user account holder that receives funds. Allowable Values: 1–36 chars |
| peer_transfer.sender_business_token string Optional | Specifies the business account holder that sends funds. Allowable Values: 1–36 chars |
| peer_transfer.sender_user_token string Optional | Specifies the user account holder that sends funds. Allowable Values: 1–36 chars |
| peer_transfer.tags string Optional | Metadata about the intra-account transfer. Allowable Values: 1–255 chars |
| peer_transfer.token string Required | Unique identifier of the intra-account transfer request. Allowable Values: 1–36 chars |
| polarity string Optional | Indicates whether the transaction is credit or debit. Allowable Values: CREDIT, DEBIT, PENDING_CREDIT, PENDING_DEBIT |
| pos object Optional | 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. Allowable Values: Existing pos object |
| pos.card_data_input_capability string Optional | How the terminal accepts card data. Allowable Values: 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 |
| pos.card_holder_presence boolean Optional | Whether the cardholder was present during the transaction. Allowable Values: true, false |
| pos.card_presence boolean Optional | Whether the card was present during the transaction. Allowable Values: true, false |
| pos.cardholder_authentication_method string Optional | Method used to authenticate the cardholder. Allowable Values: UNSPECIFIED, NON_AUTHENTICATED, SIGNATURE, PIN, ID_VERIFIED |
| pos.country_code string Optional | Country code of the card acceptor or terminal. Allowable Values: Valid 3-digit ISO 3166 country code |
| pos.county string Optional | County of the card acceptor or terminal. Allowable Values: 255 char max |
| pos.is_installment boolean Optional | Whether the transaction is an installment payment. Allowable Values: true, false |
| pos.is_recurring boolean Optional | Whether the transaction is recurring. Allowable Values: true, false |
| pos.pan_entry_mode string Optional | Method used for capturing the card primary account number (PAN) during the transaction. Allowable Values: UNKNOWN, MANUAL, MAG_STRIPE, MAG_STRIPE_CONTACTLESS, BAR_CODE, OCR, MICR, CHIP, CHIP_CONTACTLESS, CARD_ON_FILE, CHIP_FALLBACK, OTHER |
| pos.partial_approval_capable boolean Optional | Indicates whether the card acceptor or terminal supports partial-approval transactions. Allowable Values: true, false |
| pos.pin_entry_mode string Optional | 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. Allowable Values: UNKNOWN, TRUE, FALSE, DEFECTIVE |
| pos.pin_present boolean Optional | Indicates whether the cardholder entered a PIN during the transaction. Allowable Values: true, false |
| pos.purchase_amount_only boolean Optional | Indicates whether the card acceptor or terminal supports purchase-only approvals. Allowable Values: true, false |
| pos.special_condition_indicator string Optional | Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction. These transactions typically involve non-financial institutions. Allowable Values: CRYPTOCURRENCY_PURCHASE, DEBT_PAYMENT, QUASI_CASH, CENTRAL_BANK_DIGITAL_CURRENCY_PURCHASE, STABLECOIN_PURCHASE, BLOCKCHAIN_NATIVE_TOKEN_PURCHASE, NON_FUNGIBLE_TOKEN_PURCHASE, UNSPECIFIED |
| pos.state string Optional | State, province, or territory of the card acceptor or terminal. Allowable Values: 255 char max |
| pos.terminal_attendance string Optional | Whether the card acceptor/terminal was attended. Allowable Values: UNSPECIFIED, ATTENDED, UNATTENDED, NO_TERMINAL |
| pos.terminal_id string Optional | Card acceptor or terminal identification number. Allowable Values: 255 char max |
| pos.terminal_location string Optional | Location of the card acceptor/terminal. Allowable Values: ON_PREMISE, OFF_PREMISE_MERCHANT, OFF_PREMISE_CARDHOLDER, NO_TERMINAL |
| pos.terminal_type string Optional | Type of card acceptor/terminal. Allowable Values: AUTO_DISPENSER_WITH_PIN, SELF_SERVICE, LIMITED_AMOUNT, IN_FLIGHT, ECOMMERCE, TRANSPONDER |
| pos.transaction_initiated_by string Optional | Specifies the initiator of the transaction. Allowable Values: CONSUMER, MERCHANT, UNKNOWN |
| pos.transaction_initiated_category string Optional | Specifies the category of a point-of-sale transaction. Allowable Values: 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 |
| pos.zip string Optional | United States ZIP code of the card acceptor or terminal. Allowable Values: 10 char max |
| preceding_related_transaction_token string Optional | 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 Transaction events in Event Types.Allowable Values: UUID |
| preceding_transaction object Optional | Returned for authorization.clearing transaction types following a financial advice.Contains information about the preceding transaction. Allowable Values: Existing preceding_transaction object |
| preceding_transaction.amount decimal Optional | Amount of the preceding transaction. Allowable Values: decimal Format: 0.00 |
| preceding_transaction.token string Optional | Unique identifier of the preceding transaction. Allowable Values: Existing transaction token |
| program object Optional | Information about the program on the Marqeta platform. Allowable Values: Existing program object |
| program.long_code string Required | The program long code on the Marqeta platform. Allowable Values: 255 char max |
| program.program_id string Required | The program identifier on the Marqeta platform. Allowable Values: 255 char max |
| program.short_code string Required | The program short code on the Marqeta platform. Allowable Values: 255 char max |
| program_transfer object Optional | Contains information about a program transfer, which moves funds from an account holder’s GPA to a program funding source. Allowable Values: amount, business_token, created_time, currency_code, fees, jit_funding, memo, tags, token, transaction_token, type_token, user_token |
| program_transfer.amount decimal Required | Amount of program transfer. Allowable Values: decimal Format: 0.00 |
| program_transfer.business_token string Optional | Unique identifier of the business account holder. Returned if user_token is not specified.Allowable Values: 1–36 chars |
| program_transfer.created_time datetime Optional | Date and time when the program transfer object was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| program_transfer.currency_code string Required | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| program_transfer.fees array of objects Optional | Contains attributes that define characteristics of one or more fees. Allowable Values: Valid array of one or more fees objects |
| program_transfer.fees[].fee object Required | Contains details about the fee. Allowable Values: amount, created_time, currency_code, last_modified_time, name, tags, token |
| program_transfer.fees[].fee.amount decimal Required | Amount of the fee. Allowable Values: decimal Format: 0.00 |
| program_transfer.fees[].fee.created_time datetime Required | Date and time when the fees object was created, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| program_transfer.fees[].fee.currency_code string Required | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| program_transfer.fees[].fee.last_modified_time datetime Required | Date and time when the fees object was last modified, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| program_transfer.fees[].fee.name string Required | Name of the fee. Allowable Values: 50 char max |
| program_transfer.fees[].fee.tags string Optional | Descriptive metadata about the fee. Allowable Values: 255 char max |
| program_transfer.fees[].fee.token string Required | Unique identifier of the fees object.Allowable Values: Existing fees object token |
| program_transfer.fees[].memo string Optional | Additional text describing the fee. Allowable Values: 1–255 chars |
| program_transfer.fees[].overrideAmount decimal Optional | Dynamic fee amount that overrides the fee.amount field value.Allowable Values: decimal Format: 0.00 |
| program_transfer.fees[].tags string Optional | Descriptive metadata about the fee. Allowable Values: 255 char max |
| program_transfer.fees[].token string Required | Unique identifier of the fee. Allowable Values: 1–36 chars |
| program_transfer.fees[].transaction_token string Required | Unique identifier of the fee transaction. Allowable Values: 36 char max |
| program_transfer.jit_funding object Optional | 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. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| program_transfer.jit_funding.acting_user_token string Optional | User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max |
| program_transfer.jit_funding.address_verification object Optional | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| program_transfer.jit_funding.address_verification.gateway object Optional | 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. Allowable Values: on_file, response |
| program_transfer.jit_funding.address_verification.gateway.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| program_transfer.jit_funding.address_verification.gateway.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| program_transfer.jit_funding.address_verification.gateway.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| program_transfer.jit_funding.address_verification.gateway.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| program_transfer.jit_funding.address_verification.gateway.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| program_transfer.jit_funding.address_verification.gateway.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| program_transfer.jit_funding.address_verification.gateway.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| program_transfer.jit_funding.address_verification.gateway.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| program_transfer.jit_funding.address_verification.issuer object Optional | 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. Allowable Values: on_file, response |
| program_transfer.jit_funding.address_verification.issuer.on_file object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| program_transfer.jit_funding.address_verification.issuer.on_file.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| program_transfer.jit_funding.address_verification.issuer.on_file.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| program_transfer.jit_funding.address_verification.issuer.on_file.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| program_transfer.jit_funding.address_verification.issuer.response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| program_transfer.jit_funding.address_verification.issuer.response.additional_information string Optional | 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. Allowable Values: 255 char max |
| program_transfer.jit_funding.address_verification.issuer.response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| program_transfer.jit_funding.address_verification.issuer.response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| program_transfer.jit_funding.address_verification.request object Optional | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| program_transfer.jit_funding.address_verification.request.postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| program_transfer.jit_funding.address_verification.request.street_address string Optional | Street name and number of the address. Allowable Values: 40 char max |
| program_transfer.jit_funding.address_verification.request.zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
| program_transfer.jit_funding.jit_account_name_verification object Optional | 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.Allowable Values: gateway, issuer, request |
| program_transfer.jit_funding.jit_account_name_verification.gateway object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| program_transfer.jit_funding.jit_account_name_verification.issuer object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| program_transfer.jit_funding.jit_account_name_verification.request object Optional | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| program_transfer.jit_funding.amount decimal Required | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| program_transfer.jit_funding.balances object Optional | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| program_transfer.jit_funding.business_token string Optional | Holder of the business account that was funded. Allowable Values: 36 char max |
| program_transfer.jit_funding.decline_reason string Optional | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| program_transfer.jit_funding.incremental_authorization_jit_funding_tokens array of strings Optional | 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. Allowable Values: Existing incremental authorization JIT Funding tokens |
| program_transfer.jit_funding.memo string Optional | Additional information that describes the JIT Funding transaction. Allowable Values: 99 char max |
| program_transfer.jit_funding.method string Required | JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values: pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| program_transfer.jit_funding.original_jit_funding_token string Optional | 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. Allowable Values: 36 char max |
| program_transfer.jit_funding.tags string Optional | Customer-defined tags related to the JIT Funding transaction. Allowable Values: 255 char max |
| program_transfer.jit_funding.token string Required | 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.Allowable Values: 36 char max |
| program_transfer.jit_funding.user_token string Required | Holder of the user account that was funded. Allowable Values: 36 char max |
| program_transfer.memo string Optional | Additional description of the program transfer. Allowable Values: 1–99 chars |
| program_transfer.tags string Optional | Comma-delimited list of tags describing the program transfer. Allowable Values: 1–255 chars |
| program_transfer.token string Optional | Unique identifier of the program transfer. Allowable Values: 1–36 chars |
| program_transfer.transaction_token string Required | Unique identifier of the transaction. Allowable Values: Existing transaction token |
| program_transfer.type_token string Required | Unique identifier of the program transfer type. Allowable Values: 1–36 chars |
| program_transfer.user_token string Optional | Unique identifier of the user account holder. Returned if business_token is not specified.Allowable Values: 1–36 chars |
| real_time_fee_group object Optional | Contains information about a real-time fee group. Allowable Values: active, created_time, fee_tokens, last_modified_time, name, token |
| real_time_fee_group.active boolean Required | Indicates whether the real-time fee group is active. Allowable Values: true, false |
| real_time_fee_group.created_time datetime Optional | Date and time when the real-time fee group was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| real_time_fee_group.fee_tokens array of strings Optional | Specifies the fees in this real-time fee group. Allowable Values: Array of existing fee tokens |
| real_time_fee_group.last_modified_time datetime Optional | Date and time when the real-time fee group was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| real_time_fee_group.name string Required | Descriptive name for the real-time fee group. Allowable Values: 50 char max |
| real_time_fee_group.token string Required | Unique identifier of the real-time fee group. Allowable Values: 36 char max |
| request_amount decimal Optional | Merchant-requested amount, including any fees. Allowable Values: decimal Format: 0.00 |
| response object Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| response.additional_information string Optional | 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. Allowable Values: 255 char max |
| response.code string Required | 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 exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor 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: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| response.memo string Required | Additional text that describes the response. Allowable Values: 255 char max |
| settlement_date datetime Optional | 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. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| settlement_indicator string Optional | Indicates the settlement service used for the transaction. Allowable Values: INTERNATIONAL_SETTLEMENT_SERVICE, NATIONAL_NET_SETTLEMENT_SERVICE, CLEARING_ONLY, VISA_SELECTS_SETTLEMENT_SERVICE |
| standin_approved_by string Optional | 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. Allowable Values: NETWORK, COMMANDO_AUTO, COMMANDO_MANUAL |
| standin_by string Optional | Indicates which party approved a transaction: the card network using stand-in processing, or Marqeta using Commando Mode. Allowable Values: NETWORK, COMMANDO_AUTO, COMMANDO_MANUAL |
| standin_reason string Optional | Indicates why the card network handled a transaction requiring stand-in processing. Allowable Values: 255 char max |
| state string Required | Current state of the transaction. For more information about the state field, see The transaction lifecycle.Allowable Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR |
| subnetwork string Optional | 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. Allowable Values: VISANET, VISANETDEBIT, VISAINTERLINK, VISAPLUS, MAESTRO, CIRRUS, MASTERCARDDEBIT, GATEWAY_JIT, MANAGED_JIT |
| to_account string Optional | Specifies the receiving account type. Allowable Values: DEFAULT, OTHER, SAVINGS, CHECKING, CREDIT CARD, DEFERRED DEBIT, CHARGE, CREDIT LINE, CORPORATE, CREDIT FACILITY, UNIVERSAL, MONEY MARKET INVESTMENT, IRA INVESTMENT, EMPLOYEE BENEFIT, STORED VALUE, REVOLVING LOAN, MORTGAGE, INSTALLMENT LOAN ACCOUNT, REAL ESTATE LOAN, CHILD CARE BENEFIT, CASH BENEFIT, UNKNOWN, FOOD STAMP |
| token string Required | Unique identifier of the transaction, formatted as a UUID. NOTE: For subsequent related transactions, this token value appears as the preceding_related_transaction_token.Allowable Values: 1–36 chars |
| transaction_attributes object Optional | Additional transaction attributes. Allowable Values: 255 char max |
| transaction_metadata object Optional | 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. Allowable Values: Existing transaction_metadata object |
| transaction_metadata.airline object Optional | Contains information about airline-related transactions. Allowable Values: Existing airline object |
| transaction_metadata.airline.depart_date datetime Optional | The date and time of departure. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| transaction_metadata.airline.origination_city string Optional | The city where the flight originates. Allowable Values: 255 char max |
| transaction_metadata.airline.passenger_name string Optional | The name of the passenger. Allowable Values: 255 char max |
| transaction_metadata.authorization_life_cycle integer Optional | Number of days the pre-authorization is in effect. Allowable Values: Any integer |
| transaction_metadata.cross_border_transaction boolean Optional | Whether the transaction is cross-border, i.e., when the merchant and the cardholder are located in two different countries. Allowable Values: true, false |
| transaction_metadata.is_deferred_authorization boolean Optional | Indicates an offline authorization made during an interruption of card network connectivity, such as a purchase on a flight. Allowable Values: true, false |
| transaction_metadata.is_lodging_auto_rental boolean Optional | Whether the transaction is a lodging or vehicle rental. Allowable Values: true, false |
| transaction_metadata.lodging_auto_rental_start_date datetime Optional | Date and time when the lodging check-in or vehicle rental began. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| transaction_metadata.memo string Optional | Indicates a credit or debit adjustment in a clearing transaction. Allowable Values: CREDIT_ADJUSTMENT, DEBIT_ADJUSTMENT |
| transaction_metadata.moto_indicator string Optional | Indicates the type of mail or telephone order transaction. Allowable Values: UNKNOWN, MANUAL, RECURRING, INSTALLMENT, OTHERS |
| transaction_metadata.payment_channel string Optional | Channel from which the transaction was originated. Allowable Values: OTHER, ATM, ECOMMERCE, MAIL, PHONE, MOTO |
| transaction_metadata.transaction_category string Optional | Type of product or service being purchased, if provided by the merchant. Allowable Values: RETAIL_SALE, BILL_PAY, HOTEL, HEALTH_CARE, RESTAURANT, AUTO_RENTAL, AIRLINE, PAYMENT, HOSPITALIZATION_COLLEGE, PHONE_MAIL_ECOMMERCE, ATM, TRANSIT, EXTENDED_AUTHORIZATION |
| transaction_metadata.transit object Optional | Contains merchant-provided, transit-related metadata related to the transaction. Allowable Values: Existing transit object |
| transaction_metadata.transit.transaction_type string Optional | Type of transit transaction. Allowable Values: PRE_FUNDED, REAL_TIME_AUTHORIZED, POST_AUTHORIZED_AGGREGATED, AUTHORIZED_AGGREGATED_SPLIT_CLEARING, DEBIT_RECOVERY, OTHER |
| transaction_metadata.transit.transportation_mode string Optional | Mode of transportation. Allowable Values: 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 Required | Transaction event type. For more information about the type field, see Transaction events.Allowable Values: account.credit, account.debit, account.funding.authorization, account.funding.authorization.reversal, account.funding.authorization.clearing, accountfunding.pull, accountfunding.pull.chargeback, accountfunding.pull.chargeback.rev, authorization, authorization.advice, authorization.atm.withdrawal, authorization.cashback, authorization.clearing, authorization.clearing.atm.withdrawal, authorization.clearing.cashback, authorization.clearing.chargeback, authorization.clearing.chargeback.completed, authorization.clearing.chargeback.provisional.credit, authorization.clearing.chargeback.provisional.debit, authorization.clearing.chargeback.reversal, authorization.clearing.chargeback.writeoff, authorization.clearing.quasi.cash, authorization.incremental, authorization.pin.change, authorization.pin.unblock, authorization.quasi.cash, authorization.reversal, authorization.reversal.issuerexpiration, authorization.standin, balanceinquiry, directdeposit.credit, directdeposit.credit.pending, directdeposit.credit.pending.reversal, directdeposit.credit.reject, directdeposit.credit.reversal, directdeposit.debit, directdeposit.debit.pending, directdeposit.debit.pending.reversal, directdeposit.debit.reject, directdeposit.debit.reversal, dispute.credit, dispute.debit, fee.charge, fee.charge.pending, fee.charge.pending.refund, fee.charge.reversal, funds.expire, gpa.credit, gpa.credit.authorization, gpa.credit.authorization.billpayment, gpa.credit.authorization.billpayment.reversal, gpa.credit.authorization.reversal, gpa.credit.billpayment, gpa.credit.chargeback, gpa.credit.chargeback.reversal, gpa.credit.issueroperator, gpa.credit.pending, gpa.credit.pending.reversal, gpa.credit.reversal, gpa.credit.networkload, gpa.credit.networkload.reversal, gpa.debit, gpa.debit.issueroperator, gpa.debit.networkload, gpa.debit.pending, gpa.debit.pending.reversal, gpa.debit.reversal, gpa.grant, original.credit.authorization, original.credit.authorization.clearing, original.credit.authorization.reversal, original.credit.auth_plus_capture, original.credit.auth_plus_capture.reversal, pin.change.reversal, pin.change.reversal.advice, pindebit, pindebit.atm.withdrawal, pindebit.authorization, pindebit.authorization.clearing, pindebit.authorization.reversal, pindebit.authorization.reversal.issuerexpiration, pindebit.balanceinquiry, pindebit.cashback, pindebit.chargeback, pindebit.chargeback.completed, pindebit.chargeback.provisional.credit, pindebit.chargeback.provisional.debit, pindebit.chargeback.reversal, pindebit.chargeback.writeoff, pindebit.credit.adjustment, pindebit.pin.change, pindebit.pin.unblock, pindebit.quasicash, pindebit.refund, pindebit.refund.reversal, pindebit.reversal, pindebit.transfer, product.inquiry, programreserve.credit, programreserve.debit, pullfromcard.pull, pullfromcard.pull.chargeback, pullfromcard.pull.chargeback.rev, pullfromcard.pull.reversal, pushtocard.debit, pushtocard.reversal, refund, refund.authorization, refund.authorization.advice, refund.authorization.clearing, refund.authorization.reversal, reward.earn, token.activation-request, token.advice, transfer.fee, transfer.peer, transfer.program, transit.offer, unknown |
| user object Optional | Contains customer-provided information about the cardholder that performed the transaction. Allowable Values: Existing cardholder_metadata object |
| user.metadata object Optional | Associates customer-provided metadata with the cardholder. Allowable Values: Up to 20 name-value pair fields in “field_name_1”: “field_value_1” format. |
| user_token string Optional | 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.Allowable Values: 36 char max |
| user_transaction_time datetime Optional | Date and time when the user initiated the transaction, in UTC. For example, when a merchant performed the original authorization for a refund. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
List transactions
Action:GET
Endpoint: /transactions
List all transactions.
By default, this endpoint returns transactions conducted within the last 30 days. To return transactions older than 30 days, you must include the start_date and end_date query parameters in your request.
By default, GET /transactions returns transactions having either PENDING or COMPLETION states.
This endpoint supports field filtering and pagination.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | The number of transactions to retrieve. Allowable Values: 1-100 |
| start_index integer Optional | The sort order index of the first resource in the returned array. Allowable Values: Any integer |
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
| sort_by string Optional | Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: -created_time, created_time, -user_transaction_time, user_transaction_time |
| start_date string Optional | The starting date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the start_date and end_date fields.Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS |
| end_date string Optional | The ending date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the end_date and start_date fields.Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS |
| type string Optional | Comma-delimited list of transaction types to include. Allowable Values: - account.credit- account.debit- account.funding.authorization- account.funding.authorization.reversal- account.funding.authorization.clearing- accountfunding.pull- accountfunding.pull.chargeback- accountfunding.pull.chargeback.rev- authorization- authorization.advice- authorization.atm.withdrawal- authorization.cashback- authorization.clearing- authorization.clearing.atm.withdrawal- authorization.clearing.cashback- authorization.clearing.chargeback- authorization.clearing.chargeback.completed- authorization.clearing.chargeback.provisional.credit- authorization.clearing.chargeback.provisional.debit- authorization.clearing.chargeback.reversal- authorization.clearing.chargeback.writeoff- authorization.clearing.quasi.cash- authorization.incremental- authorization.quasi.cash- authorization.reversal- authorization.reversal.issuerexpiration- authorization.standin- balanceinquiry- directdeposit.credit- directdeposit.credit.pending- directdeposit.credit.pending.reversal- directdeposit.credit.reject- directdeposit.credit.reversal- directdeposit.debit- directdeposit.debit.pending- directdeposit.debit.pending.reversal- directdeposit.debit.reject- directdeposit.debit.reversal- dispute.credit- dispute.debit- fee.charge- fee.charge.pending- fee.charge.pending.refund- fee.charge.reversal- funds.expire- gpa.credit- gpa.credit.authorization- gpa.credit.authorization.billpayment- gpa.credit.authorization.billpayment.reversal- gpa.credit.authorization.reversal- gpa.credit.billpayment- gpa.credit.chargeback- gpa.credit.chargeback.reversal- gpa.credit.issueroperator- gpa.credit.pending- gpa.credit.pending.reversal- gpa.credit.reversal- gpa.credit.networkload- gpa.credit.networkload.reversal- gpa.debit- gpa.debit.issueroperator- gpa.debit.networkload- gpa.debit.pending- gpa.debit.pending.reversal- gpa.debit.reversal- gpa.grant- original.credit.authorization- original.credit.authorization.clearing- original.credit.authorization.reversal- original.credit.auth_plus_capture- original.credit.auth_plus_capture.reversal- pindebit- pindebit.atm.withdrawal- pindebit.authorization- pindebit.authorization.clearing- pindebit.authorization.reversal- pindebit.authorization.reversal.issuerexpiration- pindebit.balanceinquiry- pindebit.cashback- pindebit.chargeback- pindebit.chargeback.completed- pindebit.chargeback.provisional.credit- pindebit.chargeback.provisional.debit- pindebit.chargeback.reversal- pindebit.chargeback.writeoff- pindebit.credit.adjustment- pindebit.quasicash- pindebit.refund- pindebit.refund.reversal- pindebit.reversal- pindebit.transfer- product.inquiry- programreserve.credit- programreserve.debit- pullfromcard.pull- pullfromcard.pull.chargeback- pullfromcard.pull.chargeback.rev- pullfromcard.pull.reversal- pushtocard.debit- pushtocard.reversal- refund- refund.authorization- refund.authorization.advice- refund.authorization.clearing- refund.authorization.reversal- reward.earn- token.activation-request- token.advice- transfer.fee- transfer.peer- transfer.program- transit.offer- unknown |
| user_token string Optional | The unique identifier of the user account holder. Allowable Values: Existing user token |
| business_token string Optional | The unique identifier of the business account holder. Allowable Values: Existing business token |
| acting_user_token string Optional | The unique identifier of the acting user. Allowable Values: Existing user token |
| card_token string Optional | The unique identifier of the card. Allowable Values: Existing card token |
| state string Optional | Comma-delimited list of transaction states to display. Allowable Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR |
| version string Optional | Specifies the API version for the request. Allowable Values: v1, v2, v3 |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | The number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
| data array of objects Conditionally returned | An array of transaction objects. See the Transaction object description at the top of this page. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more transaction objects |
| end_index integer Conditionally returned | The sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | The sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Sample response body
JSON
{
"count": 2,
"start_index": 0,
"end_index": 1,
"is_more": true,
"data": [
{
"type": "gpa.credit.authorization",
"state": "PENDING",
"token": "cd22cff7-2845-4508-a916-cf89fd9edae1",
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"card_token": "02cc766c-24a5-4c3b-adcf-0e5e27b09329",
"preceding_related_transaction_token": "06a8fe88-58b1-4682-a8ad-96eb973e1d74",
"gpa": {
"currency_code": "USD",
"ledger_balance": 20,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": 10,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 20,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": 10
}
}
},
"gpa_order": {
"token": "592b8164-a4af-45ee-ab24-13a4bb43e6b2",
"amount": 10,
"created_time": "2024-08-21T17:26:30Z",
"last_modified_time": "2024-08-21T17:26:30Z",
"transaction_token": "cd22cff7-2845-4508-a916-cf89fd9edae1",
"state": "PENDING",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"funding": {
"amount": 10,
"source": {
"type": "programgateway",
"token": "**********dd5f",
"active": true,
"name": "PGFS for simulating transactions",
"is_default_account": false,
"created_time": "2024-08-21T17:25:43Z",
"last_modified_time": "2024-08-21T17:25:43Z"
},
"gateway_log": {
"order_number": "1200",
"transaction_id": "your-jit-funding-token",
"message": "Approved or completed successfully",
"duration": 481,
"timed_out": false,
"response": {
"code": "200",
"data": {
"jit_funding": {
"token": "your-jit-funding-token",
"method": "pgfs.authorization",
"user_token": "your-jit-funding-user",
"amount": 10,
"original_jit_funding_token": "your-jit-funding-token",
"address_verification": {
"gateway": {
"on_file": {
"street_address": "2000 High St",
"postal_code": "94601"
},
"response": {
"code": "0000",
"memo": "Address and postal code match"
}
}
}
}
}
}
}
},
"funding_source_token": "**********dd5f",
"jit_funding": {
"token": "251bdc52-588a-4291-8c5d-6ded3a67e1a8",
"method": "pgfs.authorization",
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"amount": 10
},
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"currency_code": "USD"
},
"duration": 537,
"created_time": "2024-08-21T17:26:29Z",
"issuer_received_time": "2024-08-21T17:26:29Z",
"user_transaction_time": "2024-08-21T17:26:29Z",
"issuer_payment_node": "b9a60cd41a2cc1c23090ed3666bdbf1z",
"amount": 10,
"currency_code": "USD",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"network": "MARQETA",
"subnetwork": "GATEWAY_JIT",
"acquirer": {
"institution_country": "840",
"institution_id_code": "428399181",
"retrieval_reference_number": "528294182583",
"system_trace_audit_number": "656761"
},
"user": {
"metadata": null
},
"card": {
"metadata": null
},
"card_security_code_verification": {
"type": "CVV1",
"response": {
"code": "0000",
"memo": "Card security code match"
}
},
"fraud": {
"network": {
"transaction_risk_score": 97,
"account_risk_score": "7"
}
},
"pos": {
"pan_entry_mode": "MAG_STRIPE",
"pin_entry_mode": "TRUE",
"terminal_attendance": "ATTENDED",
"card_holder_presence": false,
"card_presence": false,
"partial_approval_capable": false,
"purchase_amount_only": false,
"is_recurring": false
},
"transaction_metadata": {
"payment_channel": "OTHER"
}
},
{
"type": "authorization",
"state": "PENDING",
"token": "06a8fe88-58b1-4682-a8ad-96eb973e1d74",
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"card_token": "02cc766c-24a5-4c3b-adcf-0e5e27b09329",
"gpa": {
"currency_code": "USD",
"ledger_balance": 20,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 20,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10
}
}
},
"gpa_order": {
"token": "592b8164-a4af-45ee-ab24-13a4bb43e6b2",
"amount": 10,
"created_time": "2024-08-21T17:26:30Z",
"last_modified_time": "2024-08-21T17:26:30Z",
"transaction_token": "cd22cff7-2845-4508-a916-cf89fd9edae1",
"state": "PENDING",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"funding": {
"amount": 10,
"source": {
"type": "programgateway",
"token": "**********dd5f",
"active": true,
"name": "PGFS for simulating transactions",
"is_default_account": false,
"created_time": "2024-08-21T17:25:43Z",
"last_modified_time": "2024-08-21T17:25:43Z"
},
"gateway_log": {
"order_number": "1200",
"transaction_id": "your-jit-funding-token",
"message": "Approved or completed successfully",
"duration": 481,
"timed_out": false,
"response": {
"code": "200",
"data": {
"jit_funding": {
"token": "your-jit-funding-token",
"method": "pgfs.authorization",
"user_token": "your-jit-funding-user",
"amount": 10,
"original_jit_funding_token": "your-jit-funding-token",
"address_verification": {
"gateway": {
"on_file": {
"street_address": "2000 High St",
"postal_code": "94601"
},
"response": {
"code": "0000",
"memo": "Address and postal code match"
}
}
}
}
}
}
},
"funding_source_token": "**********dd5f",
"jit_funding": {
"token": "251bdc52-588a-4291-8c5d-6ded3a67e1a8",
"method": "pgfs.authorization",
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"amount": 10
},
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"currency_code": "USD"
}
},
"duration": 622,
"created_time": "2024-08-21T17:26:29Z",
"issuer_received_time": "2024-08-21T17:26:29Z",
"user_transaction_time": "2024-08-21T17:26:29Z",
"settlement_date": "2024-08-21T00:00:00Z",
"issuer_payment_node": "b9a60cd41a2cc1c23090ed3666bdbf1z",
"request_amount": 10,
"amount": 10,
"currency_code": "USD",
"approval_code": "761515",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"network": "VISA",
"subnetwork": "VISANET",
"acquirer_fee_amount": 0,
"acquirer": {
"institution_country": "840",
"institution_id_code": "428399181",
"retrieval_reference_number": "528294182583",
"system_trace_audit_number": "656761"
},
"user": {
"metadata": null
},
"card": {
"metadata": null
},
"card_security_code_verification": {
"type": "CVV1",
"response": {
"code": "0000",
"memo": "Card security code match"
}
},
"fraud": {
"network": {
"transaction_risk_score": 97,
"account_risk_score": "7"
}
},
"card_acceptor": {
"mid": "000000000011111",
"mcc": "6411",
"name": "Aegis Fleet Services",
"street_address": "111 Main St",
"city": "Berkeley",
"country_code": "USA"
},
"pos": {
"pan_entry_mode": "MAG_STRIPE",
"pin_entry_mode": "TRUE",
"terminal_id": "TR100000",
"terminal_attendance": "ATTENDED",
"card_holder_presence": false,
"card_presence": false,
"partial_approval_capable": false,
"purchase_amount_only": false,
"is_recurring": false
},
"transaction_metadata": {
"payment_channel": "OTHER"
}
}
]
}
List transactions for a funding account
Action:GET
Endpoint: /transactions/fundingsource/{funding_source_token}
List transactions for a specific funding source.
By default, this endpoint returns transactions conducted within the last 30 days. To return transactions older than 30 days, you must include the start_date and end_date query parameters in your request.
By default, GET /transactions/fundingsource/{funding_source_token} returns transactions having either PENDING or COMPLETION states.
This endpoint supports field filtering and pagination.
URL path parameters
| Fields | Description |
|---|---|
| funding_source_token string Required | The unique identifier of the funding account. Allowable Values: Existing funding source token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | The number of transactions to retrieve. Allowable Values: 1-100 |
| start_index integer Optional | The sort order index of the first resource in the returned array. Allowable Values: Any integer |
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
| sort_by string Optional | Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: -created_time, created_time, -user_transaction_time, user_transaction_time |
| start_date string Optional | The starting date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the start_date and end_date fields.Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS |
| end_date string Optional | The ending date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the end_date and start_date fields.Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS |
| type string Optional | Comma-delimited list of transaction types to include. Allowable Values: - account.credit- account.debit- account.funding.authorization- account.funding.authorization.reversal- account.funding.authorization.clearing- accountfunding.pull- accountfunding.pull.chargeback- accountfunding.pull.chargeback.rev- authorization- authorization.advice- authorization.atm.withdrawal- authorization.cashback- authorization.clearing- authorization.clearing.atm.withdrawal- authorization.clearing.cashback- authorization.clearing.chargeback- authorization.clearing.chargeback.completed- authorization.clearing.chargeback.provisional.credit- authorization.clearing.chargeback.provisional.debit- authorization.clearing.chargeback.reversal- authorization.clearing.chargeback.writeoff- authorization.clearing.quasi.cash- authorization.incremental- authorization.pin.change- authorization.pin.unblock- authorization.quasi.cash- authorization.reversal- authorization.reversal.issuerexpiration- authorization.standin- balanceinquiry- directdeposit.credit- directdeposit.credit.pending- directdeposit.credit.pending.reversal- directdeposit.credit.reject- directdeposit.credit.reversal- directdeposit.debit- directdeposit.debit.pending- directdeposit.debit.pending.reversal- directdeposit.debit.reject- directdeposit.debit.reversal- dispute.credit- dispute.debit- fee.charge- fee.charge.pending- fee.charge.pending.refund- fee.charge.reversal- funds.expire- gpa.credit- gpa.credit.authorization- gpa.credit.authorization.billpayment- gpa.credit.authorization.billpayment.reversal- gpa.credit.authorization.reversal- gpa.credit.billpayment- gpa.credit.chargeback- gpa.credit.chargeback.reversal- gpa.credit.issueroperator- gpa.credit.pending- gpa.credit.pending.reversal- gpa.credit.reversal- gpa.credit.networkload- gpa.credit.networkload.reversal- gpa.debit- gpa.debit.issueroperator- gpa.debit.networkload- gpa.debit.pending- gpa.debit.pending.reversal- gpa.debit.reversal- gpa.grant- original.credit.authorization- original.credit.authorization.clearing- original.credit.authorization.reversal- original.credit.auth_plus_capture- original.credit.auth_plus_capture.reversal- pin.change.reversal- pin.change.reversal.advice- pindebit- pindebit.atm.withdrawal- pindebit.authorization- pindebit.authorization.clearing- pindebit.authorization.reversal- pindebit.authorization.reversal.issuerexpiration- pindebit.balanceinquiry- pindebit.cashback- pindebit.chargeback- pindebit.chargeback.completed- pindebit.chargeback.provisional.credit- pindebit.chargeback.provisional.debit- pindebit.chargeback.reversal- pindebit.chargeback.writeoff- pindebit.credit.adjustment- pindebit.pin.change- pindebit.pin.unblock- pindebit.quasicash- pindebit.refund- pindebit.refund.reversal- pindebit.reversal- pindebit.transfer- product.inquiry- programreserve.credit- programreserve.debit- pullfromcard.pull- pullfromcard.pull.chargeback- pullfromcard.pull.chargeback.rev- pullfromcard.pull.reversal- pushtocard.debit- pushtocard.reversal- refund- refund.authorization- refund.authorization.advice- refund.authorization.clearing- refund.authorization.reversal- reward.earn- token.activation-request- token.advice- transfer.fee- transfer.peer- transfer.program- transit.offer- unknown |
| polarity string Optional | Specifies whether to return credit or debit transactions. Allowable Values: CREDIT, DEBIT, PENDING_CREDIT, PENDING_DEBIT |
| version string Optional | Specifies the API version for the request. Allowable Values: v1, v2, v3 |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | The number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
| data array of objects Conditionally returned | An array of transaction objects. See the Transaction object description at the top of this page. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more transaction objects |
| end_index integer Conditionally returned | The sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | The sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Retrieve transaction
Action:GET
Endpoint: /transactions/{token}
Retrieve a specific transaction. Include the token path parameter to identify the transaction.
Note
Transactions are not available in real time via this endpoint, and typically appear after 30 seconds. On occasion, a transaction may require up to four hours to appear.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | The unique identifier of the transaction. Allowable Values: Existing transaction token |
URL query parameters
| Fields | Description |
|---|---|
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
| version string Optional | Specifies the API version for the request. Allowable Values: v1, v2, v3 |
Response body
See Transaction object.Sample response body
JSON
{
"type": "authorization",
"state": "PENDING",
"token": "06a8fe88-58b1-4682-a8ad-96eb973e1d74",
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"card_token": "02cc766c-24a5-4c3b-adcf-0e5e27b09329",
"gpa": {
"currency_code": "USD",
"ledger_balance": 20,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 20,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10
}
}
},
"gpa_order": {
"token": "592b8164-a4af-45ee-ab24-13a4bb43e6b2",
"amount": 10,
"created_time": "2024-08-21T17:26:30Z",
"last_modified_time": "2024-08-21T17:26:30Z",
"transaction_token": "cd22cff7-2845-4508-a916-cf89fd9edae1",
"state": "PENDING",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"funding": {
"amount": 10,
"source": {
"type": "programgateway",
"token": "**********dd5f",
"active": true,
"name": "PGFS for simulating transactions",
"is_default_account": false,
"created_time": "2024-08-21T17:25:43Z",
"last_modified_time": "2024-08-21T17:25:43Z"
},
"gateway_log": {
"order_number": "1200",
"transaction_id": "your-jit-funding-token",
"message": "Approved or completed successfully",
"duration": 481,
"timed_out": false,
"response": {
"code": "200",
"data": [
{
"jit_funding": {
"token": "your-jit-funding-token",
"method": "pgfs.authorization",
"user_token": "your-jit-funding-user",
"amount": 10,
"original_jit_funding_token": "your-jit-funding-token",
"address_verification": {
"gateway": {
"on_file": {
"street_address": "2000 High St",
"postal_code": "94601"
},
"response": {
"code": "0000",
"memo": "Address and postal code match"
}
}
}
}
}
]
}
}
},
"funding_source_token": "**********dd5f",
"jit_funding": {
"token": "251bdc52-588a-4291-8c5d-6ded3a67e1a8",
"method": "pgfs.authorization",
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"amount": 10
},
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"currency_code": "USD"
},
"duration": 622,
"created_time": "2024-08-21T17:26:29Z",
"user_transaction_time": "2024-08-21T17:26:29Z",
"issuer_received_time": "2024-08-21T17:26:29Z",
"settlement_date": "2024-08-21T00:00:00Z",
"issuer_payment_node": "b9a60cd41a2cc1c23090ed3666bdbf1z",
"request_amount": 10,
"amount": 10,
"currency_conversion": {
"network": {
"original_amount": 10,
"conversion_rate": 1,
"original_currency_code": "840",
"dynamic_currency_conversion": false
}
},
"currency_code": "USD",
"approval_code": "761515",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"network": "VISA",
"subnetwork": "VISANET",
"acquirer_fee_amount": 0,
"acquirer": {
"institution_country": "840",
"institution_id_code": "428399181",
"retrieval_reference_number": "528294182583",
"system_trace_audit_number": "656761"
},
"user": {
"metadata": null
},
"card": {
"metadata": null
},
"card_security_code_verification": {
"type": "CVV1",
"response": {
"code": "0000",
"memo": "Card security code match"
}
},
"fraud": {
"network": {
"transaction_risk_score": 97,
"account_risk_score": "7"
}
},
"cardholder_authentication_data": {
"electronic_commerce_indicator": "authentication_successful",
"verification_result": "verified",
"verification_value_created_by": "issuer_acs"
},
"card_acceptor": {
"mid": "000000000011111",
"mcc": "6411",
"name": "Aegis Fleet Services",
"street_address": "111 Main St",
"city": "Berkeley",
"country_code": "USA"
},
"pos": {
"pan_entry_mode": "MAG_STRIPE",
"pin_entry_mode": "TRUE",
"terminal_id": "TR100000",
"terminal_attendance": "ATTENDED",
"card_holder_presence": false,
"card_presence": false,
"partial_approval_capable": false,
"purchase_amount_only": false,
"is_recurring": false
},
"transaction_metadata": {
"payment_channel": "OTHER"
}
}
List related transactions
Action:GET
Endpoint: /transactions/{token}/related
List all transactions related to the specified transaction.
By default, this endpoint returns transactions conducted within the last 30 days. To return transactions older than 30 days, you must include the start_date and end_date query parameters in your request.
By default, this endpoint returns transactions of any state. To return transactions in specific states, you must include the state query parameter in your request.
This endpoint supports field filtering and pagination.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | The unique identifier of the transaction. Allowable Values: Existing transaction token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | The number of transactions to retrieve. Allowable Values: 1-100 |
| start_index integer Optional | The sort order index of the first resource in the returned array. Allowable Values: Any integer |
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
| sort_by string Optional | Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: -created_time, created_time, -user_transaction_time, user_transaction_time |
| start_date string Optional | The starting date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the start_date and end_date fields.Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS |
| end_date string Optional | The ending date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the end_date and start_date fields.Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS |
| type string Optional | Comma-delimited list of transaction types to include. Allowable Values: - account.credit- account.debit- account.funding.authorization- account.funding.authorization.reversal- account.funding.authorization.clearing- accountfunding.pull- accountfunding.pull.chargeback- accountfunding.pull.chargeback.rev- authorization- authorization.advice- authorization.atm.withdrawal- authorization.cashback- authorization.clearing- authorization.clearing.atm.withdrawal- authorization.clearing.cashback- authorization.clearing.chargeback- authorization.clearing.chargeback.completed- authorization.clearing.chargeback.provisional.credit- authorization.clearing.chargeback.provisional.debit- authorization.clearing.chargeback.reversal- authorization.clearing.chargeback.writeoff- authorization.clearing.quasi.cash- authorization.incremental- authorization.pin.change- authorization.pin.unblock- authorization.quasi.cash- authorization.reversal- authorization.reversal.issuerexpiration- authorization.standin- balanceinquiry- directdeposit.credit- directdeposit.credit.pending- directdeposit.credit.pending.reversal- directdeposit.credit.reject- directdeposit.credit.reversal- directdeposit.debit- directdeposit.debit.pending- directdeposit.debit.pending.reversal- directdeposit.debit.reject- directdeposit.debit.reversal- dispute.credit- dispute.debit- fee.charge- fee.charge.pending- fee.charge.pending.refund- fee.charge.reversal- funds.expire- gpa.credit- gpa.credit.authorization- gpa.credit.authorization.billpayment- gpa.credit.authorization.billpayment.reversal- gpa.credit.authorization.reversal- gpa.credit.billpayment- gpa.credit.chargeback- gpa.credit.chargeback.reversal- gpa.credit.issueroperator- gpa.credit.pending- gpa.credit.pending.reversal- gpa.credit.reversal- gpa.credit.networkload- gpa.credit.networkload.reversal- gpa.debit- gpa.debit.issueroperator- gpa.debit.networkload- gpa.debit.pending- gpa.debit.pending.reversal- gpa.debit.reversal- gpa.grant- original.credit.authorization- original.credit.authorization.clearing- original.credit.authorization.reversal- original.credit.auth_plus_capture- original.credit.auth_plus_capture.reversal- pin.change.reversal- pin.change.reversal.advice- pindebit- pindebit.atm.withdrawal- pindebit.authorization- pindebit.authorization.clearing- pindebit.authorization.reversal- pindebit.authorization.reversal.issuerexpiration- pindebit.balanceinquiry- pindebit.cashback- pindebit.chargeback- pindebit.chargeback.completed- pindebit.chargeback.provisional.credit- pindebit.chargeback.provisional.debit- pindebit.chargeback.reversal- pindebit.chargeback.writeoff- pindebit.credit.adjustment- pindebit.pin.change- pindebit.pin.unblock- pindebit.quasicash- pindebit.refund- pindebit.refund.reversal- pindebit.reversal- pindebit.transfer- product.inquiry- programreserve.credit- programreserve.debit- pullfromcard.pull- pullfromcard.pull.chargeback- pullfromcard.pull.chargeback.rev- pullfromcard.pull.reversal- pushtocard.debit- pushtocard.reversal- refund- refund.authorization- refund.authorization.advice- refund.authorization.clearing- refund.authorization.reversal- reward.earn- token.activation-request- token.advice- transfer.fee- transfer.peer- transfer.program- transit.offer- unknown |
| state string Optional | Comma-delimited list of transaction states to display. Allowable Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL |
| version string Optional | Specifies the API version for the request. Allowable Values: v1, v2, v3 |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | The number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
| data array of objects Conditionally returned | An array of transaction objects. See the Transaction object description at the top of this page. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more transaction objects |
| end_index integer Conditionally returned | The sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | The sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Sample response body
JSON
{
"count": 1,
"start_index": 0,
"end_index": 0,
"is_more": false,
"data": [
{
"type": "gpa.credit.authorization",
"state": "PENDING",
"token": "cd22cff7-2845-4508-a916-cf89fd9edae1",
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"card_token": "02cc766c-24a5-4c3b-adcf-0e5e27b09329",
"preceding_related_transaction_token": "06a8fe88-58b1-4682-a8ad-96eb973e1d74",
"gpa": {
"currency_code": "USD",
"ledger_balance": 20,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": 10,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 20,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": 10
}
}
},
"gpa_order": {
"token": "592b8164-a4af-45ee-ab24-13a4bb43e6b2",
"amount": 10,
"created_time": "2024-08-21T17:26:30Z",
"last_modified_time": "2024-08-21T17:26:30Z",
"transaction_token": "cd22cff7-2845-4508-a916-cf89fd9edae1",
"state": "PENDING",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"funding": {
"amount": 10,
"source": {
"type": "programgateway",
"token": "**********dd5f",
"active": true,
"name": "PGFS for simulating transactions",
"is_default_account": false,
"created_time": "2024-08-21T17:25:43Z",
"last_modified_time": "2024-08-21T17:25:43Z"
},
"gateway_log": {
"order_number": "1200",
"transaction_id": "your-jit-funding-token",
"message": "Approved or completed successfully",
"duration": 481,
"timed_out": false,
"response": {
"code": "200",
"data": {
"jit_funding": {
"token": "your-jit-funding-token",
"method": "pgfs.authorization",
"user_token": "your-jit-funding-user",
"amount": 10,
"original_jit_funding_token": "your-jit-funding-token",
"address_verification": {
"gateway": {
"on_file": {
"street_address": "2000 High St",
"postal_code": 94601
},
"response": {
"code": "0000",
"memo": "Address and postal code match"
}
}
}
}
}
}
},
"funding_source_token": "**********dd5f",
"jit_funding": {
"token": "251bdc52-588a-4291-8c5d-6ded3a67e1a8",
"method": "pgfs.authorization",
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"amount": 10
},
"user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8",
"currency_code": "USD"
}
},
"duration": 537,
"created_time": "2024-08-21T17:26:29Z",
"issuer_received_time": "2024-08-21T17:26:29Z",
"user_transaction_time": "2024-08-21T17:26:29Z",
"issuer_payment_node": "b9a60cd41a2cc1c23090ed3666bdbf1z",
"amount": 10,
"currency_code": "USD",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"network": "MARQETA",
"subnetwork": "GATEWAY_JIT",
"acquirer": {
"institution_country": "840",
"institution_id_code": "428399181",
"retrieval_reference_number": "528294182583",
"system_trace_audit_number": "656761"
},
"user": {
"metadata": null
},
"card": {
"metadata": null
},
"card_security_code_verification": {
"type": "CVV1",
"response": {
"code": "0000",
"memo": "Card security code match"
}
},
"fraud": {
"network": {
"transaction_risk_score": 97,
"account_risk_score": "7"
}
},
"pos": {
"pan_entry_mode": "MAG_STRIPE",
"pin_entry_mode": "TRUE",
"terminal_attendance": "ATTENDED",
"card_holder_presence": false,
"card_presence": false,
"partial_approval_capable": false,
"purchase_amount_only": false,
"is_recurring": false
},
"transaction_metadata": {
"payment_channel": "OTHER"
}
}
]
}