Transactions
The /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.
List transactions
Copy section link
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
Copy section link
Fields | Description |
---|---|
count
integer
|
The number of transactions to retrieve. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
start_date
string
|
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 Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS |
end_date
string
|
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 Allowable Values: Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS |
type
string
|
Comma-delimited list of transaction types to include. Allowable Values:
|
user_token
string
|
The unique identifier of the user account holder. Allowable Values: Existing user token |
business_token
string
|
The unique identifier of the business account holder. Allowable Values: Existing business token |
acting_user_token
string
|
The unique identifier of the acting user. Allowable Values: Existing user token |
card_token
string
|
The unique identifier of the card. Allowable Values: Existing card token |
state
string
|
Comma-delimited list of transaction states to display. Allowable Values:
|
version
string
|
Specifies the API version for the request. Allowable Values:
|
verbose
boolean
|
If Allowable Values:
|
Response body
Copy section link
Fields | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
count
integer
|
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
|
An array of transaction objects. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more transaction objects |
||||||||||||||||||||||||||||||
data[].acquirer
object
|
Contains information about the merchant’s financial institution. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].acquirer.institution_country
string
|
Country code of the merchant’s financial institution. Allowable Values: Valid alpha-3 ISO 3166 country code |
||||||||||||||||||||||||||||||
data[].acquirer.institution_id_code
string
|
Identifier code of the merchant’s financial institution. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].acquirer.network_international_id
string
|
The international network identifier. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].acquirer.retrieval_reference_number
string
|
Retrieval reference number of the merchant’s financial institution. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].acquirer.system_trace_audit_number
string
|
System trace audit number of the merchant’s financial institution. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].acquirer_fee_amount
decimal
|
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: |
||||||||||||||||||||||||||||||
data[].acquirer_reference_id
string
|
Acquirer-assigned unique identifier of the transaction. Useful for settlement and reconciliation. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].acting_user_token
string
|
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 |
||||||||||||||||||||||||||||||
data[].address_verification
object
|
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:
|
||||||||||||||||||||||||||||||
data[].address_verification.on_file
object
|
Contains address verification information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].address_verification.on_file.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].address_verification.on_file.street_address
string
|
Street name and number of the address. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].address_verification.on_file.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].address_verification.request
object
|
Contains address verification information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].address_verification.request.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].address_verification.request.street_address
string
|
Street name and number of the address. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].address_verification.request.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].address_verification.response
object
|
Response codes and memos for address verification, card security verification, and transactions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].address_verification.response.additional_information
string
|
Information about the velocity control applied to the transaction. NOTE: This field is returned only in transaction response objects. It is not returned in address verification or card security verification response objects. Allowable Values: The |
||||||||||||||||||||||||||||||
data[].address_verification.response.code
string
|
Four-digit response code for address verification, card security code verification, or transactions. For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:
For card security verification, the code indicates whether the verification check passed and can have these possible values:
For 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 |
||||||||||||||||||||||||||||||
data[].address_verification.response.memo
string
|
Additional text that describes the response. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].amount
decimal
|
Amount of the transaction. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].amount_to_be_released
decimal
|
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: |
||||||||||||||||||||||||||||||
data[].approval_code
string
|
Unique identifier assigned to an authorization, printed on the receipt at point of sale. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].auto_reload
object
|
Contains information about an auto reload. See Auto Reloads for more information. Returned if an auto reload was executed. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].auto_reload.active
boolean
|
Specifies whether the auto reload is active. Only one auto reload per level, per object, can be active. Allowable Values:
Default value: |
||||||||||||||||||||||||||||||
data[].auto_reload.association
object
|
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:
|
||||||||||||||||||||||||||||||
data[].auto_reload.association.business_token
string
|
Unique identifier of the business for which the auto reload is configured. Send a Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].auto_reload.association.card_product_token
string
|
Unique identifier of the card product for which the auto reload is configured. Send a Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].auto_reload.association.user_token
string
|
Unique identifier of the user for which the auto reload is configured. Send a Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].auto_reload.currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
||||||||||||||||||||||||||||||
data[].auto_reload.funding_source_address_token
string
|
Unique identifier of the funding source address to use for this auto reload. If your funding source is an ACH account, then a Send a Send a Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].auto_reload.funding_source_token
string
|
Unique identifier of the funding source to use for this auto reload. Send a Send a Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].auto_reload.order_scope
object
|
Defines the balance threshold and reload amounts. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].auto_reload.order_scope.gpa
object
|
Defines the type of order. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].auto_reload.order_scope.gpa.reload_amount
decimal
|
Available balance on the card after the reload has completed. This value must be greater than or equal to the value of Allowable Values: 0.01 min |
||||||||||||||||||||||||||||||
data[].auto_reload.order_scope.gpa.trigger_amount
decimal
|
Threshold that determines when the reload happens. The reload is triggered when the card balance falls below this amount. Allowable Values: 0.01 min |
||||||||||||||||||||||||||||||
data[].auto_reload.token
string
|
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 |
||||||||||||||||||||||||||||||
data[].batch_number
string
|
The batch number of the transaction. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].business
object
|
Contains customer-provided information about the business that funded the transaction. Allowable Values: Existing business metadata |
||||||||||||||||||||||||||||||
data[].business.metadata
object
|
Associates customer-provided metadata with the business. Allowable Values: Up to 20 name-value pair fields in |
||||||||||||||||||||||||||||||
data[].business_token
string
|
Unique identifier of the business that owns the account that funded the transaction. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].card
object
|
Contains information about the card used in the transaction. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.activation_actions
object
|
Defines actions to execute when the card is activated. The fields in this object are mutually exclusive. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.activation_actions.swap_digital_wallet_tokens_from_card_token
string
|
Moves all digital wallet tokens from the specified card to the new card. Not relevant when Send a Allowable Values: 1–36 chars Existing card token |
||||||||||||||||||||||||||||||
data[].card.activation_actions.terminate_reissued_source_card
boolean
|
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 Only relevant when Allowable Values:
Default value: |
||||||||||||||||||||||||||||||
data[].card.barcode
string
|
Barcode printed on the card, expressed as numerals. Allowable Values: 10-20 chars |
||||||||||||||||||||||||||||||
data[].card.bulk_issuance_token
string
|
Unique identifier of the bulk card order. Allowable Values: 1-36 chars |
||||||||||||||||||||||||||||||
data[].card.card_product_token
string
|
Unique identifier of the card product. Allowable Values: 1-36 chars |
||||||||||||||||||||||||||||||
data[].card.chip_cvv_number
string
|
Three-digit card verification value (ICVV) stored on the chip of the card. Allowable Values: 3 chars |
||||||||||||||||||||||||||||||
data[].card.contactless_exemption_counter
integer
|
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 |
||||||||||||||||||||||||||||||
data[].card.contactless_exemption_total_amount
decimal
|
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 |
||||||||||||||||||||||||||||||
data[].card.created_time
datetime
|
Date and time when the resource was created, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].card.cvv_number
string
|
Three-digit card verification value (CVV2 or CVC2) printed on the card. Allowable Values: 3 chars |
||||||||||||||||||||||||||||||
data[].card.expedite
boolean
|
A value of Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.expiration
string
|
Expiration date in Allowable Values: Format: MMyy |
||||||||||||||||||||||||||||||
data[].card.expiration_time
datetime
|
Expiration date and time, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].card.fulfillment
object
|
Determines physical characteristics of a card and shipment information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_fulfillment_reason
string
|
Descriptive reason for the card fulfillment. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization
object
|
Specifies personalized attributes to be added to the card. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.carrier
object
|
Specifies attributes of the card carrier. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.carrier.logo_file
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.carrier.logo_thumbnail_file
string
|
Specifies a thumbnail-sized rendering of the image specified in the Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.carrier.message_file
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.carrier.message_line
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.carrier.template_id
string
|
Specifies the card carrier template to use. Allowable Values: Card carrier template ID |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images.card
object
|
Specifies personalized images that appear on the card. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images.card.name
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images.card.thermal_color
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images.carrier
object
|
Specifies personalized images that appear on the card carrier. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images.carrier.message_1
string
|
Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images.carrier.name
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images.carrier_return_window
object
|
Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images.carrier_return_window.name
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images.signature
object
|
Specifies a PNG image of the cardholder’s signature. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.images.signature.name
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.perso_type
string
|
Specifies the type of card personalization. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.text
object
|
Specifies personalized text that appears on the card. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.text.name_line_1
object
|
Specifies the first line of personalized text that appears on the card. Allowable Values:
21 char max; if Strings longer than the character limit are truncated. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.text.name_line_1.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.text.name_line_2
object
|
Specifies the second line of personalized text that appears on the card. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.text.name_line_2.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.text.name_line_3
object
|
Specifies the third line of personalized text that appears on the card. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.card_personalization.text.name_line_3.value
string
|
Line of personalized text printed on the card. Allowable Values: 21 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping
object
|
Specifies shipping details for the order. This object is returned if it exists in the resource. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.care_of_line
string
|
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 |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.method
string
|
Specifies the shipping service. This field is returned if it exists in the resource. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address
object
|
Address to which the order will be shipped. This field is returned if it exists in the resource. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.address1
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.address2
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.city
string
|
City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.country
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.first_name
string
|
First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.last_name
string
|
Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.middle_name
string
|
Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.phone
string
|
Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.postal_code
string
|
Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.state
string
|
State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.recipient_address.zip
string
|
United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address
object
|
Address to which the order will be returned if shipping fails. This object is returned if it exists in the resource. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.address1
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.address2
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.city
string
|
City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.country
string
|
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. |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.first_name
string
|
First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.last_name
string
|
Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.middle_name
string
|
Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.phone
string
|
Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.postal_code
string
|
Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.state
string
|
State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment.shipping.return_address.zip
string
|
United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].card.fulfillment_status
string
|
Card fulfillment status:
Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.instrument_type
string
|
Instrument type of the card:
Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.last_four
string
|
Last four digits of the card primary account number (PAN). Allowable Values: 4 chars |
||||||||||||||||||||||||||||||
data[].card.last_modified_time
datetime
|
Date and time when the resource was last modified, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].card.metadata
object
|
Associates customer-provided metadata with the card. Allowable Values: Contains the names and values of up to 20 fields in the format |
||||||||||||||||||||||||||||||
data[].card.pan
string
|
Primary account number (PAN) of the card. Allowable Values: 16 char max |
||||||||||||||||||||||||||||||
data[].card.pin_is_set
boolean
|
Specifies if the personal identification number (PIN) has been set for the card. Allowable Values: 4 chars |
||||||||||||||||||||||||||||||
data[].card.reissue_pan_from_card_token
string
|
Reissues the specified card (known as the "source" card). Allowable Values: Existing card token |
||||||||||||||||||||||||||||||
data[].card.new_pan_from_card_token
string
|
Reissues the specified card (known as the "source" card) with a new primary account number (PAN). Allowable Values: Existing card token |
||||||||||||||||||||||||||||||
data[].card.state
string
|
Indicates the state of the card. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card.state_reason
string
|
Descriptive reason for why the card is in its current state. For example, "Card activated by cardholder". Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card.token
string
|
Unique identifier of the card. Allowable Values: Existing card token |
||||||||||||||||||||||||||||||
data[].card.translate_pin_from_card_token
string
|
Copies the personal identification number (PIN) from the specified source card to the newly created card. Allowable Values: Existing card token |
||||||||||||||||||||||||||||||
data[].card.user_token
string
|
Unique identifier of the cardholder. Allowable Values: Existing user token |
||||||||||||||||||||||||||||||
data[].card_acceptor
object
|
Contains information about the merchant. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].card_acceptor.address
string
|
Card acceptor’s address. May be returned if the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.city
string
|
Card acceptor’s city. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.country_code
string
|
Card acceptor’s country code. May be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests. Allowable Values: Valid alpha-3 ISO 3166 country code |
||||||||||||||||||||||||||||||
data[].card_acceptor.mcc
string
|
Merchant category code (MCC). Allowable Values: Existing MCC |
||||||||||||||||||||||||||||||
data[].card_acceptor.mcc_groups
array of strings
|
An array of Allowable Values: Valid array of one or more |
||||||||||||||||||||||||||||||
data[].card_acceptor.mid
string
|
The merchant identifier. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.name
string
|
Card acceptor’s name. Allowable Values: 50 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.network_mid
string
|
The merchant identifier on the card network. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.poi
object
|
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:
|
||||||||||||||||||||||||||||||
data[].card_acceptor.poi.card_presence
string
|
Indicates whether the card was present during the transaction. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.poi.cardholder_presence
string
|
Indicates whether the cardholder was present during the transaction. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.poi.partial_approval_capable
string
|
Indicates whether the card acceptor or terminal supports partial-approval transactions. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.poi.pin_present
string
|
Indicates whether the cardholder entered a PIN during the transaction. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.poi.special_condition_indicator
string
|
Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction. These transactions typically involve non-financial institutions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_acceptor.poi.tid
string
|
Card acceptor or terminal identification number. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.postal_code
string
|
Card acceptor’s postal code. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.state
string
|
Two-character state, province, or territorial abbreviation. For a complete list of valid state and province abbreviations, see Valid state, provincial, and territorial abbreviations. Note: Non-US merchants may return more than 2 char for this field. Allowable Values: 2 char max |
||||||||||||||||||||||||||||||
data[].card_acceptor.country_of_origin
string
|
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 |
||||||||||||||||||||||||||||||
data[].card_acceptor.transfer_service_provider_name
string
|
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 |
||||||||||||||||||||||||||||||
data[].card_acceptor.payment_facilitator_name
string
|
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 |
||||||||||||||||||||||||||||||
data[].card_holder_model
object
|
Contains information about a cardholder. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_holder_model.account_holder_group_token
string
|
Associates the specified account holder group with the cardholder. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.active
boolean
|
Specifies if the cardholder is in the Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_holder_model.address1
string
|
Cardholder’s address. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.address2
string
|
Additional address information for the cardholder. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.authentication
object
|
Contains the cardholder’s email address and password information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_holder_model.authentication.email_verified
boolean
|
Specifies whether the email address has been verified. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_holder_model.authentication.email_verified_time
datetime
|
Date and time when the email address was verified. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].card_holder_model.authentication.last_password_update_channel
string
|
Specifies the channel through which the password was last changed. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_holder_model.authentication.last_password_update_time
datetime
|
Date and time when the password was last changed. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].card_holder_model.birth_date
string
|
Cardholder’s date of birth. Allowable Values: Format: yyyy-MM-dd |
||||||||||||||||||||||||||||||
data[].card_holder_model.business_token
string
|
Unique identifier of the business resource. Allowable Values: Existing business resource token |
||||||||||||||||||||||||||||||
data[].card_holder_model.city
string
|
City where the cardholder resides. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.company
string
|
Company name. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.corporate_card_holder
boolean
|
Specifies if the cardholder holds a corporate card. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_holder_model.country
string
|
Country where the cardholder resides. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.created_time
datetime
|
Date and time when the resource was created, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].card_holder_model.email
string
|
Valid email address of the cardholder. Allowable Values: 1–255 chars |
||||||||||||||||||||||||||||||
data[].card_holder_model.first_name
string
|
Cardholder’s first name. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.gender
string
|
Gender of the cardholder. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_holder_model.honorific
string
|
Cardholder’s title or prefix: Dr., Miss, Mr., Ms., and so on. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.id_card_expiration_date
string
|
Expiration date of the cardholder’s identification. Allowable Values: Format: yyyy-MM-dd |
||||||||||||||||||||||||||||||
data[].card_holder_model.id_card_number
string
|
Cardholder’s identification card number. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.identifications
array of objects
|
One or more objects containing identifications associated with the cardholder. Allowable Values: Valid array of one or more |
||||||||||||||||||||||||||||||
data[].card_holder_model.identifications[].expiration_date
string
|
Expiration date for the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
||||||||||||||||||||||||||||||
data[].card_holder_model.identifications[].type
string
|
Type of identification. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_holder_model.identifications[].value
string
|
Number associated with the identification. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.ip_address
string
|
Cardholder’s IP address. Allowable Values: 39 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.last_modified_time
datetime
|
Date and time when the resource was last updated, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].card_holder_model.last_name
string
|
Cardholder’s last name. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.metadata
object
|
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 |
||||||||||||||||||||||||||||||
data[].card_holder_model.middle_name
string
|
Cardholder’s middle name. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.nationality
string
|
Cardholder’s nationality. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.notes
string
|
Any additional information pertaining to the cardholder. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.parent_token
string
|
Unique identifier of the parent user or business resource. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].card_holder_model.passport_expiration_date
string
|
Expiration date of the cardholder’s passport. Allowable Values: Format: yyyy-MM-dd |
||||||||||||||||||||||||||||||
data[].card_holder_model.passport_number
string
|
Cardholder’s passport number. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.password
string
|
Password to the cardholder’s user account on the Marqeta platform. Allowable Values: 1–255 chars |
||||||||||||||||||||||||||||||
data[].card_holder_model.phone
string
|
Cardholder’s telephone number. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.postal_code
string
|
Postal code of the cardholder’s address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.ssn
string
|
Cardholder’s Social Security Number (SSN). Allowable Values: Nine digits only, no delimiters. |
||||||||||||||||||||||||||||||
data[].card_holder_model.state
string
|
State or province where the cardholder resides. Allowable Values: 2 char max |
||||||||||||||||||||||||||||||
data[].card_holder_model.status
string
|
Specifies the status of the cardholder on the Marqeta platform. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_holder_model.token
string
|
Unique identifier of the cardholder. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].card_holder_model.uses_parent_account
boolean
|
Indicates whether the child shares balances with the parent ( Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_holder_model.zip
string
|
United States ZIP code of the cardholder’s address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].card_security_code_verification
object
|
Contains information about a verification check performed on the card’s security code. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].card_security_code_verification.response
object
|
Response codes and memos for address verification, card security verification, and transactions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_security_code_verification.response.additional_information
string
|
Information about the velocity control applied to the transaction. NOTE: This field is returned only in transaction response objects. It is not returned in address verification or card security verification response objects. Allowable Values: The |
||||||||||||||||||||||||||||||
data[].card_security_code_verification.response.code
string
|
Four-digit response code for address verification, card security code verification, or transactions. For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:
For card security verification, the code indicates whether the verification check passed and can have these possible values:
For 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 |
||||||||||||||||||||||||||||||
data[].card_security_code_verification.response.memo
string
|
Additional text that describes the response. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].card_security_code_verification.type
string
|
Indicates the type of security code. Can have these possible values:
Allowable Values:
|
||||||||||||||||||||||||||||||
data[].card_token
string
|
Unique identifier of the card. Useful when a single account holder has multiple cards. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].cardholder_authentication_data
object
|
Contains 3D Secure authentication data:
Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].cardholder_authentication_data.acquirer_exemption
array of strings
|
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:
|
||||||||||||||||||||||||||||||
data[].cardholder_authentication_data.authentication_method
string
|
Specifies the 3D Secure authentication method. Allowable Values: null,
|
||||||||||||||||||||||||||||||
data[].cardholder_authentication_data.authentication_status
string
|
Specifies the status of the 3D Secure authentication:
Allowable Values:
|
||||||||||||||||||||||||||||||
data[].cardholder_authentication_data.electronic_commerce_indicator
string
|
Status of the 3D Secure authentication attempt, as provided by a transaction participant.
Allowable Values:
|
||||||||||||||||||||||||||||||
data[].cardholder_authentication_data.issuer_exemption
string
|
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:
|
||||||||||||||||||||||||||||||
data[].cardholder_authentication_data.three_ds_message_version
string
|
Specifies the 3D Secure message version used for authentication. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].cardholder_authentication_data.verification_result
string
|
Result of cardholder authentication verification value (CAVV) or accountholder authentication value (AAV) verification performed by the card network.
Allowable Values:
|
||||||||||||||||||||||||||||||
data[].cardholder_authentication_data.verification_value_created_by
string
|
Transaction participant who determined the verification result. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].cash_back_amount
decimal
|
Amount of cash back requested by the cardholder during the transaction. Included in the total transaction amount. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].chargeback
object
|
Contains the chargeback object associated with this transaction if a chargeback has been initiated. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].chargeback.amount
decimal
|
Amount of the chargeback. Allowable Values: 0.01 min |
||||||||||||||||||||||||||||||
data[].chargeback.channel
string
|
Channel the chargeback came through. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].chargeback.created_time
datetime
|
Date and time when the chargeback was created.
Not returned for transactions when the associated chargeback is in the Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].chargeback.credit_user
boolean
|
Whether to credit the user for the chargeback amount. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].chargeback.last_modified_time
datetime
|
Date and time when the chargeback was last modified.
Not returned for transactions when the associated chargeback is in the Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].chargeback.memo
string
|
Additional comments about the chargeback. Allowable Values: 1–1024 chars |
||||||||||||||||||||||||||||||
data[].chargeback.network
string
|
Network handling the chargeback. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].chargeback.network_case_id
string
|
Network-assigned identifier of the chargeback. Allowable Values: 50 char max |
||||||||||||||||||||||||||||||
data[].chargeback.reason_code
string
|
Identifies the standardized reason for the chargeback. Allowable Values: See The reason_code field in the Cases (Visa) API reference. |
||||||||||||||||||||||||||||||
data[].chargeback.state
string
|
State of the case. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].chargeback.token
string
|
Unique identifier of the chargeback. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].chargeback.transaction_token
string
|
Unique identifier of the transaction being charged back. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].clearing_record_sequence_number
string
|
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 |
||||||||||||||||||||||||||||||
data[].created_time
datetime
|
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: |
||||||||||||||||||||||||||||||
data[].currency_code
string
|
Currency type of the transaction. Allowable Values: Valid three-digit ISO 4217 currency code |
||||||||||||||||||||||||||||||
data[].currency_conversion
object
|
Contains information about currency conversion. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].currency_conversion.network
object
|
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 |
||||||||||||||||||||||||||||||
data[].currency_conversion.network.conversion_rate
decimal
|
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. |
||||||||||||||||||||||||||||||
data[].currency_conversion.network.dynamic_currency_conversion
boolean
|
Indicates whether currency conversion was performed dynamically at the point of sale. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].currency_conversion.network.original_amount
decimal
|
Amount of the transaction in the currency in which it originated. Allowable Values: Decimal amount. |
||||||||||||||||||||||||||||||
data[].currency_conversion.network.original_currency_code
string
|
Currency type of the origination currency. Allowable Values: Valid three-digit ISO 4217 currency code |
||||||||||||||||||||||||||||||
data[].currency_conversion.network.settlement_data
object
|
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 |
||||||||||||||||||||||||||||||
data[].currency_conversion.network.settlement_data.amount
decimal
|
The settled amount. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].currency_conversion.network.settlement_data.conversion_rate
decimal
|
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. |
||||||||||||||||||||||||||||||
data[].currency_conversion.network.settlement_data.currency_code
string
|
The ISO 4217 code of the currency used in the transaction. Allowable Values: Valid three-digit ISO 4217 currency code |
||||||||||||||||||||||||||||||
data[].digital_wallet_token
object
|
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:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.address_verification
object
|
Contains address verification information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.address_verification.name
string
|
Name of the cardholder. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.address_verification.postal_code
string
|
Postal code. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.address_verification.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.address_verification.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.card_token
string
|
Unique identifier of the card. Allowable Values: Existing card token |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.created_time
datetime
|
Date and time when the digital wallet token object was created, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.device
object
|
Contains information related to the device being provisioned. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.device.device_id
string
|
Identity number of the device. Allowable Values: 24 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.device.ip_address
string
|
Device’s IP address. Allowable Values: IP address format, 50 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.device.language_code
string
|
Language the device is configured to use. Allowable Values: 50 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.device.location
string
|
Geographic coordinates of the device. Allowable Values: Latitude and longitude in NOTE: Both the longitude and latitude are prefixed with either a |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.device.name
string
|
Name of the device. Allowable Values: 50 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.device.phone_number
string
|
Device’s telephone number. Allowable Values: 50 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.device.token
string
|
Unique identifier of the device object. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.device.type
string
|
Type of device being provisioned. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.fulfillment_status
string
|
Digital wallet token’s provisioning status. For fulfillment status descriptions, see Create digital wallet token transition. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.issuer_eligibility_decision
string
|
The Marqeta platform’s decision as to whether the digital wallet token should be provisioned.
For all other values, check the value of the NOTE: The value Allowable Values: 0000, |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.last_modified_time
datetime
|
Date and time when the digital wallet token object was last modified, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.metadata
object
|
Contains additional information about the digital wallet token. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.metadata.cardproduct_preferred_notification_language
string
|
Language specified in the The ISO maintains the full list of ISO 3166 two- and three-digit numeric country codes. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.metadata.issuer_product_config_id
string
|
Unique identifier of the product configuration on the Marqeta platform. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.state
string
|
State of the digital wallet token. For state descriptions, see Transitioning Token States. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.state_reason
string
|
Reason why the digital wallet token transitioned to its current state. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token
string
|
Unique identifier of the digital wallet token. Allowable Values: Existing digital wallet token. |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider
object
|
Contains information held and provided by the token service provider (card network). Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.correlation_id
string
|
Unique value representing a tokenization request (Mastercard only). Allowable Values: Existing correlation identifier |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.pan_reference_id
string
|
Unique identifier of the digital wallet token primary account number (PAN) within the card network. Allowable Values: Existing PAN Reference ID |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.token_assurance_level
string
|
(Mastercard only) Represents the confidence level in the digital wallet token. Allowable Values: 0-99 |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.token_eligibility_decision
string
|
Digital wallet’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.token_expiration
string
|
Expiration date of the digital wallet token. Allowable Values: Format: MMyy |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.token_pan
string
|
Primary account number (PAN) of the digital wallet token. Allowable Values: 16 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.token_reference_id
string
|
Unique identifier of the digital wallet token within the card network. Allowable Values: Existing Token Reference ID |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.token_requestor_id
string
|
Unique numerical identifier of the token requestor within the card network.
These ID numbers map to Mastercard
Visa
Allowable Values: 11 char max Example Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.token_requestor_name
string
|
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:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.token_score
string
|
Token score assigned by the digital wallet. Allowable Values: 25 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.token_service_provider.token_type
string
|
Type of the digital wallet token. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user
object
|
Contains information about a cardholder. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.account_holder_group_token
string
|
Associates the specified account holder group with the cardholder. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.active
boolean
|
Specifies if the cardholder is in the Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.address1
string
|
Cardholder’s address. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.address2
string
|
Additional address information for the cardholder. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.authentication
object
|
Contains the cardholder’s email address and password information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.authentication.email_verified
boolean
|
Specifies whether the email address has been verified. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.authentication.email_verified_time
datetime
|
Date and time when the email address was verified. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.authentication.last_password_update_channel
string
|
Specifies the channel through which the password was last changed. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.authentication.last_password_update_time
datetime
|
Date and time when the password was last changed. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.birth_date
string
|
Cardholder’s date of birth. Allowable Values: Format: yyyy-MM-dd |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.business_token
string
|
Unique identifier of the business resource. Allowable Values: Existing business resource token |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.city
string
|
City where the cardholder resides. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.company
string
|
Company name. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.corporate_card_holder
boolean
|
Specifies if the cardholder holds a corporate card. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.country
string
|
Country where the cardholder resides. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.created_time
datetime
|
Date and time when the resource was created, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.email
string
|
Valid email address of the cardholder. Allowable Values: 1–255 chars |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.first_name
string
|
Cardholder’s first name. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.gender
string
|
Gender of the cardholder. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.honorific
string
|
Cardholder’s title or prefix: Dr., Miss, Mr., Ms., and so on. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.id_card_expiration_date
string
|
Expiration date of the cardholder’s identification. Allowable Values: Format: yyyy-MM-dd |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.id_card_number
string
|
Cardholder’s identification card number. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.identifications
array of objects
|
One or more objects containing identifications associated with the cardholder. Allowable Values: Valid array of one or more |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.identifications[].expiration_date
string
|
Expiration date for the identification, if applicable. Allowable Values: Format: yyyy-MM-dd |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.identifications[].type
string
|
Type of identification. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.identifications[].value
string
|
Number associated with the identification. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.ip_address
string
|
Cardholder’s IP address. Allowable Values: 39 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.last_modified_time
datetime
|
Date and time when the resource was last updated, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.last_name
string
|
Cardholder’s last name. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.metadata
object
|
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 |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.middle_name
string
|
Cardholder’s middle name. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.nationality
string
|
Cardholder’s nationality. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.notes
string
|
Any additional information pertaining to the cardholder. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.parent_token
string
|
Unique identifier of the parent user or business resource. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.passport_expiration_date
string
|
Expiration date of the cardholder’s passport. Allowable Values: Format: yyyy-MM-dd |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.passport_number
string
|
Cardholder’s passport number. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.password
string
|
Password to the cardholder’s user account on the Marqeta platform. Allowable Values: 1–255 chars |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.phone
string
|
Cardholder’s telephone number. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.postal_code
string
|
Postal code of the cardholder’s address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.ssn
string
|
Cardholder’s Social Security Number (SSN). Allowable Values: Nine digits only, no delimiters. |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.state
string
|
State or province where the cardholder resides. Allowable Values: 2 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.status
string
|
Specifies the status of the cardholder on the Marqeta platform. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.token
string
|
Unique identifier of the cardholder. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.uses_parent_account
boolean
|
Indicates whether the child shares balances with the parent ( Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.user.zip
string
|
United States ZIP code of the cardholder’s address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile
object
|
Contains information held and provided by the digital wallet provider. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.account
object
|
Contains information related to the cardholder and provided by the digital wallet provider. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.account.email_address
string
|
Digital wallet provider’s email address for the cardholder. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.account.id
string
|
Digital wallet provider’s identity number for the cardholder. Allowable Values: 20 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.account.score
string
|
Score from the digital wallet provider. Allowable Values: 50 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.device_score
string
|
Score from the device. Allowable Values: 50 char max |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.pan_source
string
|
Source from which the digital wallet provider obtained the card primary account number (PAN). Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.reason_code
string
|
Reason for the wallet provider’s provisioning decision.
Allowable Values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 0A, 0B, 0C, 0D, 0E, 0G |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.recommendation_reasons
array of strings
|
Array of recommendation reasons from the digital wallet provider. Allowable Values: Valid array of one or more recommendation reasons |
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.risk_assessment
object
|
Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.risk_assessment.score
string
|
Wallet provider’s decision as to whether the digital wallet token should be provisioned. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].digital_wallet_token.wallet_provider_profile.risk_assessment.version
string
|
Wallet provider’s risk assessment version. Allowable Values: Version information, as provided by the wallet provider |
||||||||||||||||||||||||||||||
data[].direct_deposit
object
|
Contains information about a direct deposit. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].direct_deposit.amount
decimal
|
Amount being debited or credited. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].direct_deposit.business_token
string
|
The unique identifier of the business account holder. Allowable Values: Existing business token |
||||||||||||||||||||||||||||||
data[].direct_deposit.company_discretionary_data
string
|
Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max |
||||||||||||||||||||||||||||||
data[].direct_deposit.company_entry_description
string
|
Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max |
||||||||||||||||||||||||||||||
data[].direct_deposit.company_identification
string
|
Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].direct_deposit.company_name
string
|
Name of the direct deposit originator. Allowable Values: 16 char max |
||||||||||||||||||||||||||||||
data[].direct_deposit.created_time
datetime
|
Date and time when the direct deposit account was created. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].direct_deposit.direct_deposit_account_token
string
|
The unique identifier of the direct deposit account. Allowable Values: Existing direct deposit account token |
||||||||||||||||||||||||||||||
data[].direct_deposit.individual_identification_number
string
|
Accounting number by which the recipient is known to the direct deposit originator. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].direct_deposit.individual_name
string
|
Name of the direct deposit recipient. Allowable Values: 22 char max |
||||||||||||||||||||||||||||||
data[].direct_deposit.last_modified_time
datetime
|
Date and time when the direct deposit account was last modified. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].direct_deposit.settlement_date
datetime
|
Date and time when the credit or debit is applied. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].direct_deposit.standard_entry_class_code
string
|
Three-letter code identifying the type of entry. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].direct_deposit.state
string
|
Current status of the direct deposit record. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].direct_deposit.state_reason
string
|
Explanation for why the direct deposit record is in the current state. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].direct_deposit.state_reason_code
string
|
Standard code describing the reason for the current state. Allowable Values: See The reason_code field in the Direct Deposit API reference. |
||||||||||||||||||||||||||||||
data[].direct_deposit.token
string
|
The unique identifier of the direct deposit record. Allowable Values: Existing direct deposit record token |
||||||||||||||||||||||||||||||
data[].direct_deposit.type
string
|
Determines whether funds are being debited from or credited to the account. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].direct_deposit.user_token
string
|
The unique identifier of the user account holder. Allowable Values: Existing user token |
||||||||||||||||||||||||||||||
data[].dispute
object
|
Contains information about a disputed transaction. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].dispute.case_management_identifier
string
|
The unique identifier of the dispute case. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].dispute.reason
string
|
The reason for the dispute. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].duration
integer
|
Duration of the transaction on Marqeta’s servers, in milliseconds. Allowable Values: Any integer |
||||||||||||||||||||||||||||||
data[].enhanced_data_token
string
|
The enhanced commercial card data token for the transaction. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fee
object
|
Contains details about the fee. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fee.active
boolean
|
Indicates whether the fee is active. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fee.amount
decimal
|
Amount of the fee. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].fee.created_time
datetime
|
Date and time when the Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].fee.currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
||||||||||||||||||||||||||||||
data[].fee.last_modified_time
datetime
|
Date and time when the Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].fee.name
string
|
Name of the fee. Allowable Values: 50 char max |
||||||||||||||||||||||||||||||
data[].fee.real_time_assessment
object
|
Controls the assessment of real-time fees. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fee.real_time_assessment.domestic_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is inside the US. Allowable Values:
Default value: |
||||||||||||||||||||||||||||||
data[].fee.real_time_assessment.international_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is outside the US. Allowable Values:
Default value: |
||||||||||||||||||||||||||||||
data[].fee.real_time_assessment.transaction_type
string
|
Indicates the type of transactions on which the fee is assessed. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fee.tags
string
|
Descriptive metadata about the fee. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fee.token
string
|
Unique identifier of the Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].fee_transfer
object
|
Contains information about a fee transfer, including the amount, currency code, and user or business token. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fee_transfer.business_token
string
|
Specifies the business account holder to which the fee applies. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].fee_transfer.created_time
datetime
|
Date and time when the Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees
array of objects
|
Contains attributes that define characteristics of one or more fees. Allowable Values: Array of existing |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee
object
|
Contains details about the fee. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.active
boolean
|
Indicates whether the fee is active. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.amount
decimal
|
Amount of the fee. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.created_time
datetime
|
Date and time when the Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.last_modified_time
datetime
|
Date and time when the Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.name
string
|
Name of the fee. Allowable Values: 50 char max |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.real_time_assessment
object
|
Controls the assessment of real-time fees. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.real_time_assessment.domestic_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is inside the US. Allowable Values:
Default value: |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.real_time_assessment.international_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is outside the US. Allowable Values:
Default value: |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.real_time_assessment.transaction_type
string
|
Indicates the type of transactions on which the fee is assessed. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.tags
string
|
Descriptive metadata about the fee. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].fee.token
string
|
Unique identifier of the Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].memo
string
|
Additional text that describes the fee transfer. Allowable Values: 1–99 chars |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].tags
string
|
Descriptive metadata about the fee. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].token
string
|
Unique identifier of the fee. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].fee_transfer.fees[].transaction_token
string
|
Unique identifier of the fee transaction. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].fee_transfer.tags
string
|
Metadata about the transfer. This field is returned if it exists in the resource. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fee_transfer.token
string
|
Unique identifier of the fee transfer. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].fee_transfer.user_token
string
|
Specifies the user account holder to which the fee applies. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].fees
array of objects
|
List of fees associated with the transaction. This array is returned if it exists in the resource. Allowable Values: Array of existing |
||||||||||||||||||||||||||||||
data[].fees[].amount
decimal
|
The amount of the network fee. Allowable Values: decimal *Format:* + 0.00 |
||||||||||||||||||||||||||||||
data[].fees[].credit_debit
string
|
Indicates whether the fee is a credit or a debit.
Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fees[].type
string
|
The type of fee assessed by the card network. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud
object
|
Contains one or more fraud determinations by the card network that apply to either the transaction or the cardholder’s account. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor
object
|
Contains one or more fraud determinations by the card network that apply to either the transaction or the cardholder’s account. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.recommended_action
string
|
The rules violated by the transaction. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.risk_level
string
|
The fraud rating, or level of risk associated with the transaction. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.riskcontrol_tags
array of objects
|
The RiskControl tags that were triggered by the transaction. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.riskcontrol_tags[].rule_name
string
|
Name of the rule, as defined in the Real-Time Decisioning dashboard, that was triggered. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.riskcontrol_tags[].tag
string
|
Tag name defined in the rule definition in the Real-Time Decisioning dashboard. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.riskcontrol_tags[].values
array of strings
|
Value associated with the tag. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.rule_violations
array of strings
|
The rules violated by the transaction. Allowable Values: Valid array of |
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.score
integer
|
The risk score generated by RiskControl. This is either the Mastercard Decision Intelligence or Visa Advance Authorization transaction risk score. Allowable Values: 0-99 |
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.triggered_rules
array of objects
|
Provides a list of rules triggered by a fraud event, along with the information on tags and rule characteristics. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.triggered_rules[].alert
boolean
|
Indicates if the rule triggered an alert. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.triggered_rules[].entity_type
string
|
The entity type where the triggered rule was defined. Allowable Values: Valid entity type |
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.triggered_rules[].rule_name
string
|
Name of the rule, as defined in the Real-Time Decisioning dashboard that was triggered. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.triggered_rules[].suppress_alert
boolean
|
Indicates if the triggered rule has Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud.issuer_processor.triggered_rules[].tags
array of objects
|
All the tags defined in the triggered rule. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud.network
object
|
Contains network-provided information about fraud determinations. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud.network.account_risk_score
string
|
(Visa only) Account holder risk condition code evaluated by the card network. A higher score indicates a greater likelihood that the card number is compromised. Allowable Values: 1-9 |
||||||||||||||||||||||||||||||
data[].fraud.network.account_risk_score_reason_code
string
|
(Visa only) Unique code that describes the main driver of the Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fraud.network.transaction_risk_score
integer
|
Network-provided risk score for the transaction. A higher score indicates higher risk. Useful for making authorization decisions. Allowable Values: Mastercard: 0-999 Visa: 1-99 |
||||||||||||||||||||||||||||||
data[].fraud.network.transaction_risk_score_reason_code
string
|
(Mastercard only) Unique code that describes the main driver of the Allowable Values: 1-29 |
||||||||||||||||||||||||||||||
data[].fraud.network.transaction_risk_score_reason_description
string
|
(Mastercard only) Description of the Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fraud.network_account_intelligence_score
object
|
Account intelligence score information, as provided by the Mastercard network. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].fraud.network_account_intelligence_score.name
string
|
The name, as provided by the Mastercard network. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fraud.network_account_intelligence_score.service_type
string
|
The service type, as provided by the Mastercard network. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].fraud.network_account_intelligence_score.value
string
|
The value, as provided by the Mastercard network. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].from_account
string
|
Specifies the account type for ATM transactions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa
object
|
Returns general purpose account (GPA) balances for a user or business. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa.available_balance
decimal
|
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: |
||||||||||||||||||||||||||||||
data[].gpa.balances
object
|
Contains GPA balance information, organized by currency code. Allowable Values: One or more balances objects |
||||||||||||||||||||||||||||||
data[].gpa.cached_balance
decimal
|
Not currently in use. Allowable Values: Not applicable |
||||||||||||||||||||||||||||||
data[].gpa.credit_balance
decimal
|
Not currently in use. Allowable Values: Not applicable |
||||||||||||||||||||||||||||||
data[].gpa.currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
||||||||||||||||||||||||||||||
data[].gpa.impacted_amount
decimal
|
Balance change based on the amount of the transaction. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].gpa.last_updated_time
datetime
|
Date and time when the resource was last updated, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].gpa.ledger_balance
decimal
|
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: |
||||||||||||||||||||||||||||||
data[].gpa.pending_credits
decimal
|
ACH loads that have been accepted, but for which the funding time has not yet elapsed. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].gpa_order
object
|
Contains information about a GPA order, including fees, funding sources, and addresses. See GPA Orders for more information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.amount
decimal
|
Amount funded. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.business_token
string
|
Unique identifier of the business. This field is returned if it exists in the resource. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].gpa_order.created_time
datetime
|
Date and time when the GPA order was created, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
||||||||||||||||||||||||||||||
data[].gpa_order.fees
array of objects
|
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 |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee
object
|
Contains details about the fee. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.active
boolean
|
Indicates whether the fee is active. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.amount
decimal
|
Amount of the fee. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.created_time
datetime
|
Date and time when the Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.last_modified_time
datetime
|
Date and time when the Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.name
string
|
Name of the fee. Allowable Values: 50 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.real_time_assessment
object
|
Controls the assessment of real-time fees. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.real_time_assessment.domestic_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is inside the US. Allowable Values:
Default value: |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.real_time_assessment.international_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is outside the US. Allowable Values:
Default value: |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.real_time_assessment.transaction_type
string
|
Indicates the type of transactions on which the fee is assessed. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.tags
string
|
Descriptive metadata about the fee. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].fee.token
string
|
Unique identifier of the Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].memo
string
|
Additional text that describes the fee transfer. Allowable Values: 1–99 chars |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].tags
string
|
Descriptive metadata about the fee. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].token
string
|
Unique identifier of the fee. Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].gpa_order.fees[].transaction_token
string
|
Unique identifier of the fee transaction. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding
object
|
Contains funding information for the transaction, including funding amount, type, and time. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.amount
decimal
|
Amount of funds loaded into the GPA. Allowable Values: decimal Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log
object
|
Contains information from the JIT Funding gateway in response to a funding request. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.duration
integer
|
Length of time in milliseconds that the gateway took to respond to a funding request. Allowable Values: Any integer |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.message
string
|
Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.order_number
string
|
Customer order number, same value as Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response
object
|
Contains information from the gateway in response to a funding request. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.code
string
|
Code received from the gateway. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data
object
|
Contains the gateway’s information about the JIT Funding transaction. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding
object
|
Contains information about the JIT Funding load event, in which funds are loaded into an account. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification
object
|
Contains address verification data used to make JIT funding decisions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway
object
|
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:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address
string
|
Street name and number of the address. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response
object
|
Response codes and memos for address verification, card security verification, and transactions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the velocity control applied to the transaction. NOTE: This field is returned only in transaction response objects. It is not returned in address verification or card security verification response objects. Allowable Values: The |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code
string
|
Four-digit response code for address verification, card security code verification, or transactions. For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:
For card security verification, the code indicates whether the verification check passed and can have these possible values:
For 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 |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo
string
|
Additional text that describes the response. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer
object
|
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:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address
string
|
Street name and number of the address. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response
object
|
Response codes and memos for address verification, card security verification, and transactions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the velocity control applied to the transaction. NOTE: This field is returned only in transaction response objects. It is not returned in address verification or card security verification response objects. Allowable Values: The |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code
string
|
Four-digit response code for address verification, card security code verification, or transactions. For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:
For card security verification, the code indicates whether the verification check passed and can have these possible values:
For 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 |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo
string
|
Additional text that describes the response. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request.street_address
string
|
Street name and number of the address. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.decline_reason
string
|
Reason why the transaction was declined. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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 |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.memo
string
|
Additional information that describes the JIT Funding transaction. Allowable Values: 99 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.original_jit_funding_token
string
|
Unique identifier of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.tags
string
|
Customer-defined tags related to the JIT Funding transaction. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.token
string
|
Existing JIT Funding token matching the NOTE: The Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.response.data.jit_funding.user_token
string
|
Holder of the user account that was funded. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.timed_out
boolean
|
Whether the gateway sent a response ( Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.gateway_log.transaction_id
string
|
Customer-defined identifier for the transaction. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source
object
|
Contains funding source information for the transaction, including the funding type and time. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source.active
boolean
|
Whether the funding source is active. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source.created_time
datetime
|
Date and time when the funding source was created, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source.is_default_account
boolean
|
Whether the GPA order unload’s funding source is the default funding account. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source.last_modified_time
datetime
|
Date and time when the funding source was last modified, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source.token
string
|
Unique identifier of the funding source. Allowable Values: Format: UUID |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source.type
string
|
Funding type of the funding source. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address
object
|
Contains information about the billing address of the funding source. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.active
boolean
|
Whether the address is active. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.address_1
string
|
Street address of the funding source. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.address_2
string
|
Additional address information for the funding source. This field is returned if it exists in the resource. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.business_token
string
|
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 |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.city
string
|
City of the funding source. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.country
string
|
Country of the funding source. Allowable Values: 1–40 chars |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.created_time
datetime
|
Date and time when the address was created, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.first_name
string
|
First name of the account holder associated with the funding source. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.is_default_address
boolean
|
Whether this address is the default address used by the funding source. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.last_modified_time
datetime
|
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: |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.last_name
string
|
Last name of the account holder associated with the funding source. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.phone
string
|
Phone number of the funding source. This field is returned if it exists in the resource. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.postal_code
string
|
Postal code of the funding source. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.state
string
|
Two-character state, province, or territorial abbreviation. For the complete list, see Valid state, provincial, and territorial abbreviations. Allowable Values: 2 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.token
string
|
Unique identifier of the Allowable Values: 1–36 chars |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.user_token
string
|
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 |
||||||||||||||||||||||||||||||
data[].gpa_order.funding.source_address.zip
string
|
United States ZIP code of the funding source. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.funding_source_address_token
string
|
Unique identifier of the funding source address to use for this order. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].gpa_order.funding_source_token
string
|
Unique identifier of the funding source to use for this order. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].gpa_order.gateway_message
string
|
Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out. This field is returned if it exists in the resource. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.gateway_token
integer
|
Unique identifier of the JIT Funding request and response. This field is returned if it exists in the resource. Allowable Values: Existing |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding
object
|
Contains information about the JIT Funding load event, in which funds are loaded into an account. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification
object
|
Contains address verification data used to make JIT funding decisions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.gateway
object
|
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:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.gateway.on_file.street_address
string
|
Street name and number of the address. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.gateway.response
object
|
Response codes and memos for address verification, card security verification, and transactions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the velocity control applied to the transaction. NOTE: This field is returned only in transaction response objects. It is not returned in address verification or card security verification response objects. Allowable Values: The |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.gateway.response.code
string
|
Four-digit response code for address verification, card security code verification, or transactions. For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:
For card security verification, the code indicates whether the verification check passed and can have these possible values:
For 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 |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.gateway.response.memo
string
|
Additional text that describes the response. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.issuer
object
|
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:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.issuer.on_file.street_address
string
|
Street name and number of the address. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.issuer.response
object
|
Response codes and memos for address verification, card security verification, and transactions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the velocity control applied to the transaction. NOTE: This field is returned only in transaction response objects. It is not returned in address verification or card security verification response objects. Allowable Values: The |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.issuer.response.code
string
|
Four-digit response code for address verification, card security code verification, or transactions. For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:
For card security verification, the code indicates whether the verification check passed and can have these possible values:
For 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 |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.issuer.response.memo
string
|
Additional text that describes the response. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.request.postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.request.street_address
string
|
Street name and number of the address. Allowable Values: 40 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.address_verification.request.zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.decline_reason
string
|
Reason why the transaction was declined. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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 |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.memo
string
|
Additional information that describes the JIT Funding transaction. Allowable Values: 99 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.original_jit_funding_token
string
|
Unique identifier of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.tags
string
|
Customer-defined tags related to the JIT Funding transaction. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.token
string
|
Existing JIT Funding token matching the NOTE: The Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.jit_funding.user_token
string
|
Holder of the user account that was funded. Allowable Values: 36 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.last_modified_time
datetime
|
Date and time when the GPA order was last modified, in UTC. Allowable Values: datetime Format: |
||||||||||||||||||||||||||||||
data[].gpa_order.memo
string
|
Additional descriptive text. This field is returned if it exists in the resource. Allowable Values: 99 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.response
object
|
Response codes and memos for address verification, card security verification, and transactions. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.response.additional_information
string
|
Information about the velocity control applied to the transaction. NOTE: This field is returned only in transaction response objects. It is not returned in address verification or card security verification response objects. Allowable Values: The |
||||||||||||||||||||||||||||||
data[].gpa_order.response.code
string
|
Four-digit response code for address verification, card security code verification, or transactions. For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:
For card security verification, the code indicates whether the verification check passed and can have these possible values:
For 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 |
||||||||||||||||||||||||||||||
data[].gpa_order.response.memo
string
|
Additional text that describes the response. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.state
string
|
Current status of the funding transaction. Allowable Values:
|
||||||||||||||||||||||||||||||
data[].gpa_order.tags
string
|
Comma-delimited list of tags describing the GPA order. This field is returned if it exists in the resource. Allowable Values: 255 char max |
||||||||||||||||||||||||||||||
data[].gpa_order.token
string
|