/
540 minute read
March 23, 2022

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

Action: GET
Endpoint: /transactions

List all transactions.

By default, this endpoint returns transactions conducted within the last 30 days. To return transactions older than 30 days, you must include the start_date and end_date query parameters in your request.

By default, GET /transactions returns transactions having either PENDING or COMPLETION states.

This endpoint supports field filtering and pagination.

URL query parameters
Fields Description

count

integer
Optional

The number of transactions to retrieve.

Allowable Values:

1-10

start_index

integer
Optional

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

fields

string
Optional

Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.

Allowable Values:

Comma-delimited list of fields, or blank

sort_by

string
Optional

Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.

Allowable Values:

-created_time, created_time, -user_transaction_time, user_transaction_time

start_date

string
Optional

The starting date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the start_date and end_date fields.

Allowable Values:

Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.SS

end_date

string
Optional

The ending date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the end_date and start_date fields.

Allowable Values:

Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.SS

type

string
Optional

Comma-delimited list of transaction types to include.

Allowable Values:

account.credit, account.debit, balanceinquiry, authorization, authorization.advice, authorization.atm.withdrawal, authorization.cashback, authorization.clearing, authorization.clearing.atm.withdrawal, authorization.clearing.cashback, authorization.clearing.chargeback, authorization.clearing.chargeback.completed, authorization.clearing.chargeback.provisional.credit, authorization.clearing.chargeback.provisional.debit, authorization.clearing.chargeback.reversal, authorization.clearing.chargeback.writeoff, authorization.clearing.quasi.cash, authorization.incremental authorization.quasi.cash, authorization.reversal, authorization.reversal.issuerexpiration, directdeposit.credit, directdeposit.credit.pending, directdeposit.credit.pending.reversal, directdeposit.credit.reject, directdeposit.credit.reversal, directdeposit.debit, directdeposit.debit.pending, directdeposit.debit.pending.reversal, directdeposit.debit.reject, directdeposit.debit.reversal, dispute.credit, dispute.debit, fee.charge.pending, fee.charge.reversal, fee.charge, fee.charge.pending.refund, funds.expire, gpa.credit, gpa.credit.authorization, gpa.credit.authorization.reversal, gpa.credit.pending, gpa.credit.pending.reversal, gpa.credit.reversal, gpa.credit.networkload, gpa.credit.networkload.reversal, gpa.debit.networkload, gpa.debit, gpa.debit.pending, gpa.debit.pending.reversal, gpa.debit.reversal, gpa.grant, gpa.credit.issueroperator, gpa.debit.issueroperator, gpa.credit.chargeback, gpa.credit.chargeback.reversal, gpa.credit.billpayment, gpa.credit.authorization.billpayment, gpa.credit.authorization.billpayment.reversal, original.credit.auth_plus_capture, original.credit.auth_plus_capture.reversal, original.credit.authorization, original.credit.authorization.clearing, original.credit.authorization.reversal, pindebit, pindebit.atm.withdrawal, pindebit.authorization, pindebit.authorization.clearing, pindebit.authorization.reversal, pindebit.authorization.reversal.issuerexpiration, pindebit.balanceinquiry, pindebit.cashback, pindebit.chargeback, pindebit.chargeback.completed, pindebit.chargeback.provisional.credit, pindebit.chargeback.provisional.debit, pindebit.chargeback.reversal, pindebit.chargeback.writeoff, pindebit.credit.adjustment, pindebit.quasi.cash, pindebit.refund, pindebit.refund.reversal, pindebit.reversal, pindebit.transfer, programreserve.credit, programreserve.debit, pushtocard.debit, pushtocard.reversal, refund, refund.authorization, refund.authorization.advice, refund.authorization.clearing, refund.authorization.reversal, token.activation-request, token.advice, transfer.peer, transfer.fee, transfer.program, unknown

user_token

string
Optional

The unique identifier of the user account holder.

Allowable Values:

Existing user token

business_token

string
Optional

The unique identifier of the business account holder.

Allowable Values:

Existing business token

acting_user_token

string
Optional

The unique identifier of the acting user.

Allowable Values:

Existing user token

card_token

string
Optional

The unique identifier of the card.

Allowable Values:

Existing card token

state

string
Optional

Comma-delimited list of transaction states to display.

Allowable Values:

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL

version

string
Optional

Specifies the API version for the request.

Allowable Values:

v1, v2, v3

verbose

boolean
Optional

If true, the query returns additional information for diagnostic purposes.

Allowable Values:

true, false

Response body
Fields Description

count

integer
Conditionally returned

The number of resources to retrieve.

Allowable Values:

1-10

data

array of objects
Conditionally returned

An array of transaction objects.

Allowable Values:

One or more transaction objects

data[].acquirer

object
Conditionally returned

Contains information about the merchant’s financial institution.

Allowable Values:

Existing acquirer object

data[].acquirer.institution_country

string
Conditionally returned

Country code of the merchant’s financial institution.

Allowable Values:

Valid alpha-3 ISO 3166 country code

data[].acquirer.institution_id_code

string
Conditionally returned

Identifier code of the merchant’s financial institution.

Allowable Values:

255 char max

data[].acquirer.network_international_id

string
Conditionally returned

The international network identifier.

Allowable Values:

255 char max

data[].acquirer.retrieval_reference_number

string
Conditionally returned

Retrieval reference number of the merchant’s financial institution.

Allowable Values:

255 char max

data[].acquirer.system_trace_audit_number

string
Conditionally returned

System trace audit number of the merchant’s financial institution.

Allowable Values:

255 char max

data[].acquirer_fee_amount

decimal
Conditionally returned

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:

Format: 0.00

data[].acquirer_reference_id

string
Conditionally returned

Acquirer-assigned unique identifier of the transaction. Useful for settlement and reconciliation.

Allowable Values:

255 char max

data[].acting_user_token

string
Returned

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
Conditionally returned

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:

Existing address_verification object

data[].address_verification.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].address_verification.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].address_verification.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].address_verification.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].address_verification.request

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].address_verification.request.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].address_verification.request.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].address_verification.request.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].address_verification.response

object
Conditionally returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].address_verification.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].address_verification.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].address_verification.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].amount

decimal
Returned

Amount of the transaction.

Allowable Values:

Format: 0.00

data[].amount_to_be_released

decimal
Conditionally returned

Amount to release following a financial advice.

Allowable Values:

Format: 0.00

data[].approval_code

string
Conditionally returned

Unique identifier assigned to an authorization, printed on the receipt at point of sale.

Allowable Values:

255 char max

data[].auto_reload

object
Conditionally returned

Contains information about an auto reload. See Auto Reloads for more information.

Returned if an auto reload was executed.

Allowable Values:

Existing auto_reload object

data[].auto_reload.active

boolean
Conditionally returned

Specifies whether the auto reload is active.

Only one auto reload per level, per object, can be active.

Allowable Values:

true, false

Default value:
true

data[].auto_reload.association

object
Conditionally returned

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:

Valid association object

data[].auto_reload.association.business_token

string
Conditionally returned

The unique identifier of the business for which the auto reload is configured.

Send a GET request to /businesses to retrieve business tokens.

Allowable Values:

1–36 chars

data[].auto_reload.association.card_product_token

string
Conditionally returned

The unique identifier of the card product for which the auto reload is configured.

Send a GET request to /cardproducts to retrieve card product tokens.

Allowable Values:

1–36 chars

data[].auto_reload.association.user_token

string
Conditionally returned

The unique identifier of the user for which the auto reload is configured.

Send a GET request to /users to retrieve user tokens.

Allowable Values:

1–36 chars

data[].auto_reload.currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

Any currency code allowed by your program

data[].auto_reload.funding_source_address_token

string
Conditionally returned

The unique identifier of the funding source address to use for this auto reload.

If your funding source is an ACH account, then a funding_source_address_token is not required. If your funding source is a payment card, you must have at least one funding source address in order to create a GPA order.

Send a GET request to /fundingsources/addresses/user/{user_token} to retrieve address tokens for a user.

Send a GET request to /fundingsources/addresses/business/{business_token} to retrieve address tokens for a business.

Allowable Values:

1–36 chars

data[].auto_reload.funding_source_token

string
Conditionally returned

The unique identifier of the funding source to use for this auto reload.

Send a GET request to /fundingsources/user/{user_token} to retrieve funding source tokens for a user.

Send a GET request to /fundingsources/business/{business_token} to retrieve funding source tokens for a business.

Allowable Values:

1–36 chars

data[].auto_reload.order_scope

object
Returned

Defines the balance threshold and reload amounts.

Allowable Values:

Valid order_scope object

data[].auto_reload.order_scope.gpa

object
Conditionally returned

Defines the type of order.

Allowable Values:

Valid gpa object

data[].auto_reload.order_scope.gpa.reload_amount

decimal
Returned

The available balance on the card after the reload has completed.

This value must be greater than or equal to the value of trigger_amount. Note that this is not the same as the amount added to the card, which will vary from reload to reload.

Allowable Values:

0.01 min

data[].auto_reload.order_scope.gpa.trigger_amount

decimal
Returned

The 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
Conditionally returned

The 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
Conditionally returned

The batch number of the transaction.

Allowable Values:

255 char max

data[].business

object
Conditionally returned

Contains customer-provided information about the business that funded the transaction.

Allowable Values:

Existing business metadata

data[].business.metadata

object
Conditionally returned

Associates customer-provided metadata with the business.

Allowable Values:

Up to 20 name-value pair fields in "field_name_1": "field_value_1" format.

data[].business_token

string
Conditionally returned

Unique identifier of the business that owns the account that funded the transaction.

Allowable Values:

36 char max

data[].card

object
Conditionally returned

Contains information about the card used in the transaction.

Allowable Values:

Existing card object

data[].card.activation_actions

object
Conditionally returned

Defines actions to execute when the card is activated. The fields in this object are mutually exclusive.

Allowable Values:

Existing activation_actions object

data[].card.activation_actions.swap_digital_wallet_tokens_from_card_token

string
Conditionally returned

Moves all digital wallet tokens from the specified card to the new card.

Not relevant when reissue_pan_from_card_token is set.

Allowable Values:

1–36 chars

Existing card token.

Send a GET request to /cards/user/{token} to retrieve card tokens for a particular user.

data[].card.activation_actions.terminate_reissued_source_card

boolean
Conditionally returned

If you are reissuing a card, the source card is terminated by default. To prevent the source card from being terminated, set this field to false.

Only relevant when reissue_pan_from_card_token is set.

Allowable Values:

true, false

Default value:
true

data[].card.barcode

string
Returned

The barcode printed on the card, expressed as numerals.

Allowable Values:

10-20 chars

data[].card.bulk_issuance_token

string
Conditionally returned

The unique identifier of the bulk card order.

Allowable Values:

1-36 chars

data[].card.card_product_token

string
Returned

The unique identifier of the card product.

Allowable Values:

1-36 chars

data[].card.chip_cvv_number

string
Conditionally returned

The three-digit card verification value (ICVV) stored on the chip of the card.

Allowable Values:

3 chars

data[].card.contactless_exemption_counter

integer
Conditionally returned

A running count of contactless transactions. You can limit the number of contactless transactions that can be performed without issuing a strong customer authentication (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
Conditionally returned

A running total of money spent in contactless transactions. You can limit the total amount that can be spent in contactless transactions without issuing a strong customer authentication (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
Returned

The date and time when the resource was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].card.cvv_number

string
Conditionally returned

The three-digit card verification value (CVV2 or CVC2) printed on the card.

Allowable Values:

3 chars

data[].card.expedite

boolean
Conditionally returned

A value of true indicates that you requested expedited processing of the card from your card fulfillment provider.

Allowable Values:

true, false

data[].card.expiration

string
Returned

The expiration date in MMyy format.

Allowable Values:

Format: MMyy

data[].card.expiration_time

datetime
Returned

The expiration date and time in UTC format.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].card.fulfillment

object
Conditionally returned

Determines physical characteristics of a card and shipment information.

Allowable Values:

Existing fulfillment object

data[].card.fulfillment.card_fulfillment_reason

string
Conditionally returned

A descriptive reason for the card fulfillment.

Allowable Values:

NEW, LOST_STOLEN, EXPIRED

data[].card.fulfillment.card_personalization

object
Returned

Specifies personalized attributes to be added to the card.

Allowable Values:

Valid card_personalization object

data[].card.fulfillment.card_personalization.carrier

object
Conditionally returned

Specifies attributes of the card carrier.

Allowable Values:

Valid carrier object

data[].card.fulfillment.card_personalization.carrier.logo_file

string
Conditionally returned

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
Conditionally returned

Specifies a thumbnail-sized rendering of the image specified in the logo_file field.

Allowable Values:

Contains the name of the image file and must match the name of the file you send to your fulfillment provider.

data[].card.fulfillment.card_personalization.carrier.message_file

string
Conditionally returned

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
Conditionally returned

Specifies a custom message that appears on the card carrier.

Allowable Values:

60 char max

data[].card.fulfillment.card_personalization.carrier.template_id

string
Conditionally returned

Specifies the card carrier template to use.

Allowable Values:

A card carrier template ID

data[].card.fulfillment.card_personalization.images

object
Conditionally returned

Specifies personalized images that appear on the card.

Allowable Values:

Existing images object

data[].card.fulfillment.card_personalization.images.card

object
Conditionally returned

Specifies personalized images that appear on the card.

Allowable Values:

Valid images.card object

data[].card.fulfillment.card_personalization.images.card.name

string
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Specifies personalized images that appear on the card carrier.

Allowable Values:

Valid carrier object

data[].card.fulfillment.card_personalization.images.carrier.message_1

string
Conditionally returned

Specifies a custom message that appears on the card carrier.

Allowable Values:

60 char max

data[].card.fulfillment.card_personalization.images.carrier.name

string
Conditionally returned

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
Conditionally returned

Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders.

Allowable Values:

Valid carrier_return_window object

data[].card.fulfillment.card_personalization.images.carrier_return_window.name

string
Conditionally returned

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
Conditionally returned

Specifies a PNG image of the cardholder’s signature.

Allowable Values:

Valid signature object

data[].card.fulfillment.card_personalization.images.signature.name

string
Conditionally returned

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
Conditionally returned

Specifies the type of card personalization.

Allowable Values:

EMBOSS, LASER, FLAT

data[].card.fulfillment.card_personalization.text

object
Returned

Specifies personalized text that appears on the card.

Allowable Values:

Valid text object

data[].card.fulfillment.card_personalization.text.name_line_1

object
Returned

Specifies the first line of personalized text that appears on the card.

Allowable Values:

name_line_1.value

21 char max; if name_line_1_numeric_postfix is true, 14 char max

Strings longer than the character limit are truncated.

data[].card.fulfillment.card_personalization.text.name_line_1.value

string
Conditionally returned

A line of personalized text printed on the card.

Allowable Values:

21 char max

data[].card.fulfillment.card_personalization.text.name_line_2

object
Conditionally returned

Specifies the second line of personalized text that appears on the card.

Allowable Values:

name_line_2.value

data[].card.fulfillment.card_personalization.text.name_line_2.value

string
Conditionally returned

A line of personalized text printed on the card.

Allowable Values:

21 char max

data[].card.fulfillment.card_personalization.text.name_line_3

object
Conditionally returned

Specifies the third line of personalized text that appears on the card.

Allowable Values:

name_line_3.value

data[].card.fulfillment.card_personalization.text.name_line_3.value

string
Conditionally returned

A line of personalized text printed on the card.

Allowable Values:

21 char max

data[].card.fulfillment.shipping

object
Conditionally returned

Specifies shipping details for the order.

This object is returned if it exists in the resource.

Allowable Values:

Valid shipping object

data[].card.fulfillment.shipping.care_of_line

string
Conditionally returned

The specified value of the C/O (care of) 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
Conditionally returned

Specifies the shipping service.

This field is returned if it exists in the resource.

Allowable Values:

FEDEX_EXPEDITED, FEDEX_REGULAR, UPS_EXPEDITED, UPS_REGULAR, USPS_EXPEDITED, USPS_REGULAR

data[].card.fulfillment.shipping.recipient_address

object
Conditionally returned

Address to which the order will be shipped.

This field is returned if it exists in the resource.

Allowable Values:

Existing recipient_address object

data[].card.fulfillment.shipping.recipient_address.address1

string
Conditionally returned

Number and street.

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 limit chars to 100, and Arroweye Solutions limits chars to 50.

data[].card.fulfillment.shipping.recipient_address.address2

string
Conditionally returned

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 limit chars to 100, and Arroweye Solutions limits chars to 50.

data[].card.fulfillment.shipping.recipient_address.city

string
Conditionally returned

City.

This field is returned if it exists in the resource.

Allowable Values:

40 char max

data[].card.fulfillment.shipping.recipient_address.country

string
Conditionally returned

Country.

This field is returned if it exists in the resource.

Allowable Values:

40 char max

The English short name. For example, for 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
Conditionally returned

First name.

This field is returned if it exists in the resource.

Allowable Values:

40 char max

data[].card.fulfillment.shipping.recipient_address.last_name

string
Conditionally returned

Last name.

This field is returned if it exists in the resource.

Allowable Values:

40 char max

data[].card.fulfillment.shipping.recipient_address.middle_name

string
Conditionally returned

Middle name.

This field is returned if it exists in the resource.

Allowable Values:

40 char max

data[].card.fulfillment.shipping.recipient_address.phone

string
Conditionally returned

Telephone number.

This field is returned if it exists in the resource.

Allowable Values:

20 char max

data[].card.fulfillment.shipping.recipient_address.postal_code

string
Conditionally returned

Postal code.

This field is returned if it exists in the resource.

Allowable Values:

10 char max

data[].card.fulfillment.shipping.recipient_address.state

string
Conditionally returned

State or province.

This field is returned if it exists in the resource.

Allowable Values:

32 char max

data[].card.fulfillment.shipping.recipient_address.zip

string
Conditionally returned

United States ZIP code.

This field is returned if it exists in the resource.

Allowable Values:

10 char max

data[].card.fulfillment.shipping.return_address

object
Conditionally returned

Address to which the order will be returned if shipping fails.

This object is returned if it exists in the resource.

Allowable Values:

Existing return_address object

data[].card.fulfillment.shipping.return_address.address1

string
Conditionally returned

Number and street.

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 limit chars to 100, and Arroweye Solutions limits chars to 50.

data[].card.fulfillment.shipping.return_address.address2

string
Conditionally returned

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 limit chars to 100, and Arroweye Solutions limits chars to 50.

data[].card.fulfillment.shipping.return_address.city

string
Conditionally returned

City.

This field is returned if it exists in the resource.

Allowable Values:

40 char max

data[].card.fulfillment.shipping.return_address.country

string
Conditionally returned

Country.

This field is returned if it exists in the resource.

Allowable Values:

40 char max

The English short name. For example, for 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
Conditionally returned

First name.

This field is returned if it exists in the resource.

Allowable Values:

40 char max

data[].card.fulfillment.shipping.return_address.last_name

string
Conditionally returned

Last name.

This field is returned if it exists in the resource.

Allowable Values:

40 char max

data[].card.fulfillment.shipping.return_address.middle_name

string
Conditionally returned

Middle name.

This field is returned if it exists in the resource.

Allowable Values:

40 char max

data[].card.fulfillment.shipping.return_address.phone

string
Conditionally returned

Telephone number.

This field is returned if it exists in the resource.

Allowable Values:

20 char max

data[].card.fulfillment.shipping.return_address.postal_code

string
Conditionally returned

Postal code.

This field is returned if it exists in the resource.

Allowable Values:

10 char max

data[].card.fulfillment.shipping.return_address.state

string
Conditionally returned

State or province.

This field is returned if it exists in the resource.

Allowable Values:

32 char max

data[].card.fulfillment.shipping.return_address.zip

string
Conditionally returned

United States ZIP code.

This field is returned if it exists in the resource.

Allowable Values:

10 char max

data[].card.fulfillment_status

string
Returned

The card fulfillment status:

  • ISSUED: Initial state of all newly created/issued cards.

  • ORDERED: Card ordered through the card fulfillment provider.

  • REORDERED: Card reordered through the card fulfillment provider.

  • REJECTED: Card rejected by the card fulfillment provider.

  • SHIPPED: Card shipped by the card fulfillment provider.

  • DELIVERED: Card delivered by the card fulfillment provider.

  • DIGITALLY_PRESENTED: Card digitally presented using the /cards/{token}/showpan endpoint; does not affect the delivery of physical cards.

Allowable Values:

ISSUED, ORDERED, REORDERED, REJECTED, SHIPPED, DELIVERED, DIGITALLY_PRESENTED

data[].card.instrument_type

string
Conditionally returned

The instrument type of the card:

  • PHYSICAL_MSR: A physical card with a magnetic stripe. This is the default physical card type.

  • PHYSICAL_ICC: A physical card with an integrated circuit, or "chip."

  • PHYSICAL_CONTACTLESS: A physical card that uses radio frequency identification (RFID) or near-field communication (NFC) to enable payment over a secure radio interface.

  • PHYSICAL_COMBO: A physical card with a chip that also supports contactless payments.

  • VIRTUAL_PAN: A virtual card with a PAN.

Allowable Values:

PHYSICAL_MSR, PHYSICAL_ICC, PHYSICAL_CONTACTLESS, PHYSICAL_COMBO, VIRTUAL_PAN

data[].card.last_four

string
Returned

The last four digits of the card PAN.

Allowable Values:

4 chars

data[].card.last_modified_time

datetime
Returned

The date and time when the resource was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].card.metadata

object
Conditionally returned

Associates customer-provided metadata with the card.

Allowable Values:

Contains the names and values of up to 20 fields in the format "my_name_1": "my_value_1"

data[].card.pan

string
Returned

The primary account number (PAN) of the card.

Allowable Values:

16 char max

data[].card.pin_is_set

boolean
Returned

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
Conditionally returned

Reissues the specified card (known as the "source" card).

Allowable Values:

Existing card token

data[].card.new_pan_from_card_token

string
Conditionally returned

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
Returned

Indicates the state of the card.

Allowable Values:

ACTIVE, SUSPENDED, TERMINATED, UNSUPPORTED, UNACTIVATED, LIMITED

data[].card.state_reason

string
Returned

A descriptive reason for the state of the card.

Allowable Values:

255 char max

data[].card.token

string
Returned

The unique identifier of the card.

Allowable Values:

Existing card token

data[].card.translate_pin_from_card_token

string
Conditionally returned

Copies the PIN from the specified source card to the newly created card.

Allowable Values:

Existing card token

data[].card.user_token

string
Returned

The unique identifier of the cardholder.

Allowable Values:

Existing user token

data[].card_acceptor

object
Conditionally returned

Contains information about the merchant.

Allowable Values:

Existing card_acceptor object

data[].card_acceptor.address

string
Conditionally returned

Card acceptor’s address. May be returned if the request uses Transaction Model V1 of the Marqeta Core API. Not returned for V2 requests.

Allowable Values:

255 char max

data[].card_acceptor.city

string
Conditionally returned

Card acceptor’s city.

Allowable Values:

40 char max

data[].card_acceptor.country_code

string
Conditionally returned

Card acceptor’s country code. May be returned if the request uses Transaction Model V2 of the Marqeta Core API. Not returned for V1 requests.

Allowable Values:

Valid alpha-3 ISO 3166 country code

data[].card_acceptor.mcc

string
Conditionally returned

Merchant category code (MCC).

Allowable Values:

Existing MCC

data[].card_acceptor.mcc_groups

array of strings
Conditionally returned

An array of mcc_groups.

Allowable Values:

One or more mcc_groups

data[].card_acceptor.mid

string
Conditionally returned

The merchant identifier.

Allowable Values:

255 char max

data[].card_acceptor.name

string
Conditionally returned

Card acceptor’s name.

Allowable Values:

50 char max

data[].card_acceptor.network_mid

string
Conditionally returned

The merchant identifier on the card network.

Allowable Values:

255 char max

data[].card_acceptor.postal_code

string
Conditionally returned

Card acceptor’s postal code.

Allowable Values:

255 char max

data[].card_acceptor.state

string
Conditionally returned

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
Conditionally returned

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
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Contains information about a cardholder.

Allowable Values:

Existing user object

data[].card_holder_model.account_holder_group_token

string
Conditionally returned

Associates the specified account holder group with the cardholder.

Allowable Values:

36 char max

data[].card_holder_model.active

boolean
Conditionally returned

Specifies if the cardholder is in the ACTIVE state on the Marqeta platform.

Allowable Values:

true, false

data[].card_holder_model.address1

string
Conditionally returned

Cardholder’s address.

Allowable Values:

255 char max

data[].card_holder_model.address2

string
Conditionally returned

Additional address information for the cardholder.

Allowable Values:

255 char max

data[].card_holder_model.authentication

object
Conditionally returned

Contains the cardholder’s email address and password information.

Allowable Values:

Valid authentication object

data[].card_holder_model.authentication.email_verified

boolean
Conditionally returned

Specifies whether the email address has been verified.

Allowable Values:

true, false

data[].card_holder_model.authentication.email_verified_time

datetime
Conditionally returned

The date and time when the email address was verified.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].card_holder_model.authentication.last_password_update_channel

string
Conditionally returned

Specifies the channel through which the password was last changed.

Allowable Values:

USER_CHANGE, USER_RESET

data[].card_holder_model.authentication.last_password_update_time

datetime
Conditionally returned

The date and time when the password was last changed.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].card_holder_model.birth_date

string
Conditionally returned

Cardholder’s date of birth.

Allowable Values:

Format: yyyy-MM-dd

data[].card_holder_model.business_token

string
Conditionally returned

The unique identifier of the business resource.

Allowable Values:

Existing business token

data[].card_holder_model.city

string
Conditionally returned

City where the cardholder resides.

Allowable Values:

40 char max

data[].card_holder_model.company

string
Conditionally returned

Company name.

Allowable Values:

255 char max

data[].card_holder_model.corporate_card_holder

boolean
Conditionally returned

Specifies if the cardholder holds a corporate card.

Allowable Values:

true, false

data[].card_holder_model.country

string
Conditionally returned

Country where the cardholder resides.

Allowable Values:

40 char max

data[].card_holder_model.created_time

datetime
Returned

The date and time when the resource was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].card_holder_model.email

string
Conditionally returned

Valid email address of the cardholder.

Allowable Values:

1–255 chars

data[].card_holder_model.first_name

string
Conditionally returned

Cardholder’s first name.

Allowable Values:

40 char max

data[].card_holder_model.gender

string
Conditionally returned

Cardholder’s gender.

Allowable Values:

F, M

data[].card_holder_model.honorific

string
Conditionally returned

Cardholder’s title or prefix: Ms., Mr., Miss, Mrs., and so on.

Allowable Values:

10 char max

data[].card_holder_model.id_card_expiration_date

string
Conditionally returned

The expiration date of the cardholder’s identification card.

Allowable Values:

Format: yyyy-MM-dd

data[].card_holder_model.id_card_number

string
Conditionally returned

The cardholder’s identification card number.

Allowable Values:

255 char max

data[].card_holder_model.identifications

array of objects
Conditionally returned

One or more objects containing identifications associated with the cardholder.

Allowable Values:

Valid identifications array

data[].card_holder_model.identifications[].expiration_date

string
Conditionally returned

The expiration date for the form of identification, if applicable.

Allowable Values:

Format: yyyy-MM-dd

data[].card_holder_model.identifications[].type

string
Conditionally returned

The form of identification.

Allowable Values:

SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE

data[].card_holder_model.identifications[].value

string
Conditionally returned

The identification number associated with the form of identification.

Allowable Values:

255 char max

data[].card_holder_model.ip_address

string
Conditionally returned

Cardholder’s IP address.

Allowable Values:

39 char max

data[].card_holder_model.last_modified_time

datetime
Returned

The date and time when the resource was last updated, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].card_holder_model.last_name

string
Conditionally returned

Cardholder’s last name.

Allowable Values:

40 char max

data[].card_holder_model.metadata

object
Conditionally returned

Associates any additional metadata you provide with the cardholder.

Allowable Values:

You can define the names and values of up to 20 fields in the format "my_name_1": "my_value_1".

data[].card_holder_model.middle_name

string
Conditionally returned

Cardholder’s middle name.

Allowable Values:

40 char max

data[].card_holder_model.nationality

string
Conditionally returned

Cardholder’s nationality.

Allowable Values:

255 char max

data[].card_holder_model.notes

string
Conditionally returned

Any additional information pertaining to the cardholder.

Allowable Values:

255 char max

data[].card_holder_model.parent_token

string
Conditionally returned

The unique identifier of a user or business already in the system.

Allowable Values:

1–36 chars

data[].card_holder_model.passport_expiration_date

string
Conditionally returned

The expiration date of the cardholder’s passport.

Allowable Values:

Format: yyyy-MM-dd

data[].card_holder_model.passport_number

string
Conditionally returned

Cardholder’s passport number.

Allowable Values:

40 char max

data[].card_holder_model.password

string
Conditionally returned

Cardholder’s user account password on the Marqeta platform.

Allowable Values:

1–255 chars

data[].card_holder_model.phone

string
Conditionally returned

Cardholder’s telephone number.

Allowable Values:

255 char max

data[].card_holder_model.postal_code

string
Conditionally returned

Postal code of the cardholder’s address.

Allowable Values:

10 char max

data[].card_holder_model.ssn

string
Conditionally returned

The cardholder’s Social Security Number.

Allowable Values:

Nine digits only, no delimiters.

data[].card_holder_model.state

string
Conditionally returned

State in which the cardholder resides.

Allowable Values:

2 char max

data[].card_holder_model.status

string
Conditionally returned

Specifies the status of the cardholder on the Marqeta platform.

Allowable Values:

UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED

data[].card_holder_model.token

string
Conditionally returned

The unique identifier of the cardholder.

Allowable Values:

1–36 chars

data[].card_holder_model.uses_parent_account

boolean
Conditionally returned

Indicates whether the child shares balances with the parent (true), or the child’s balances are independent of the parent (false).

Allowable Values:

true, false

data[].card_holder_model.zip

string
Conditionally returned

ZIP code of the cardholder’s address.

Allowable Values:

10 char max

data[].card_security_code_verification

object
Conditionally returned

Contains information about a verification check performed on the card’s security code.

Allowable Values:

Existing card_security_code_verification object

data[].card_security_code_verification.response

object
Returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].card_security_code_verification.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].card_security_code_verification.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].card_security_code_verification.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].card_security_code_verification.type

string
Returned

Indicates the type of security code. Can have these possible values:

  • CVV1 – the security code stored in the magnetic stripe on the card.

  • CVV2 – the security code printed on the card.

  • ICVV – the security code stored on the chip of the card.

  • DCVV – a dynamic security code used in some contactless payments when a card or device is tapped against the card reader.

Allowable Values:

CVV1, CVV2, ICVV, DCVV

data[].card_token

string
Conditionally returned

Unique identifier of the card. Useful when a single account holder has multiple cards.

Allowable Values:

36 char max

data[].cardholder_authentication_data

object
Conditionally returned

Contains 3-D Secure verification data:

  • electronic_commerce_indicator – The level of verification performed.

  • verification_result – The result of the verification.

  • verification_value_created_by – The transaction participant who determined the verification result.

  • three_ds_message_version – The 3D Secure message version used for authentication.

  • authentication_method – The 3D Secure authentication method.

  • authentication_status – The 3D Secure authentication status.

  • acquirer_exemption – Indicates a 3D Secure authentication exemption from the acquirer.

  • issuer_exemption – Indicates a 3D Secure authentication exemption from the issuer.

Allowable Values:

Existing cardholder_authentication_data object

data[].cardholder_authentication_data.acquirer_exemption

array of strings
Conditionally returned

Indicates 3D Secure authentication exemptions from the acquirer. This array is returned if it is included in the transaction data from the card network.

Allowable Values:

MERCHANT_INITIATED_TRANSACTION, TRANSACTION_RISK_ANALYSIS, RECURRING_PAYMENT, LOW_VALUE_PAYMENT, SCA_PERFORMED, SECURE_CORPORATE_PAYMENT, AUTHENTICATION_OUTAGE_EXCEPTION

data[].cardholder_authentication_data.authentication_method

string
Conditionally returned

Specifies the 3D Secure authentication method.

Allowable Values:

null, BIOMETRIC_FACE, BIOMETRIC_FINGERPRINT, VOICE_RECOGNITION, IN_APP_LOGIN, AUDIO_CALL, VIDEO_CALL, OTP_SMS, OTP_EMAIL, KNOWLEDGE_BASED, OTHER

data[].cardholder_authentication_data.authentication_status

string
Conditionally returned

Specifies the status of the 3D Secure authentication.

Allowable Values:

SUCCESS, FAILED, CANCELLED, NOT_AUTHENTICATED

data[].cardholder_authentication_data.electronic_commerce_indicator

string
Conditionally returned

The status of the verification attempt, as provided by a transaction participant.

Allowable Values:

authentication_successful, authentication_attempted, no_authentication

data[].cardholder_authentication_data.three_ds_message_version

string
Conditionally returned

Specifies the 3D Secure message version used for authentication.

Allowable Values:

1.0.2, 2.1.0, 2.2.0

data[].cardholder_authentication_data.verification_result

string
Conditionally returned

The result of the verification attempt, as provided by a transaction participant.

Allowable Values:

  • verified

  • verified_amount_less_than_20_percent: For Mastercard AAV verification, indicates that the original authentication amount and final authorization amount are mismatched, and that the final authorization amount is less than 20% over the original authentication amount. This 20% margin falls within Mastercard’s suggested tolerance for what a European cardholder might reasonably expect when the total transaction amount is not known in advance.

  • verified_amount_greater_than_20_percent: For Mastercard AAV verification, indicates that the original authentication amount and final authorization amount are mismatched, and that the final authorization amount is greater than 20% of the original authentication amount. This 20% margin falls outside Mastercard’s suggested tolerance for what a European cardholder might reasonably expect when the total transaction amount is not known in advance.

  • failed

  • not_verified

  • not_present

  • not_provided

  • not_verified_authentication_outage

data[].cardholder_authentication_data.verification_value_created_by

string
Conditionally returned

Transaction participant who determined the verification result.

Allowable Values:

issuer_acs, issuer_attempts_server, network, network_attempts_server

data[].cash_back_amount

decimal
Conditionally returned

Amount of cash back requested by the cardholder during the transaction. Included in the total transaction amount.

Allowable Values:

Format: 0.00

data[].chargeback

object
Conditionally returned

Contains the chargeback object associated with this transaction if a chargeback has been initiated.

Allowable Values:

Existing chargeback object

data[].chargeback.amount

decimal
Returned

Amount of the chargeback.

Allowable Values:

0.01 min

data[].chargeback.channel

string
Returned

Channel the chargeback came through.

Allowable Values:

GATEWAY, GATEWAY_AUTOMATED, ISSUER, ISSUER_AUTOMATED

data[].chargeback.created_time

datetime
Returned

Date and time when the chargeback was created. Not returned for transactions when the associated chargeback is in the INITIATED state.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].chargeback.credit_user

boolean
Returned

Whether to credit the user for the chargeback amount.

Allowable Values:

true, false

data[].chargeback.last_modified_time

datetime
Returned

Date and time when the chargeback was last modified. Not returned for transactions when the associated chargeback is in the INITIATED state.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].chargeback.memo

string
Conditionally returned

Additional comments about the chargeback.

Allowable Values:

1–1024 chars

data[].chargeback.network

string
Returned

Network handling the chargeback.

Allowable Values:

MARQETA, DISCOVER, MASTERCARD, PULSE, VISA

data[].chargeback.network_case_id

string
Conditionally returned

Network-assigned identifier of the chargeback.

Allowable Values:

50 char max

data[].chargeback.reason_code

string
Conditionally returned

Identifies the standardized reason for the chargeback.

Allowable Values:

See The reason_code field in the Cases (Visa) API reference.

data[].chargeback.state

string
Returned

State of the case.

Allowable Values:

INITIATED, REPRESENTMENT, PREARBITRATION, ARBITRATION, CASE_WON, CASE_LOST, NETWORK_REJECTED, WITHDRAWN

data[].chargeback.token

string
Returned

Unique identifier of the chargeback.

Allowable Values:

1–36 chars

data[].chargeback.transaction_token

string
Returned

Unique identifier of the transaction being charged back.

Allowable Values:

1–36 chars

data[].clearing_record_sequence_number

string
Conditionally returned

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
Conditionally returned

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:

Format: yyyy-MM-ddThh:mm:ssZ

data[].currency_code

string
Conditionally returned

Currency type of the transaction.

Allowable Values:

Valid three-digit ISO 4217 currency code

data[].currency_conversion

object
Conditionally returned

Contains information about currency conversion.

Allowable Values:

Existing currency_conversion object

data[].currency_conversion.network

object
Conditionally returned

Contains information from the card network about currency conversion, including the original currency of the transaction, the amount of the transaction in the original currency, and the conversion rate.

Allowable Values:

Existing network object

data[].currency_conversion.network.conversion_rate

decimal
Conditionally returned

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
Conditionally returned

Indicates whether currency conversion was performed dynamically at the point of sale.

Allowable Values:

true, false

data[].currency_conversion.network.original_amount

decimal
Conditionally returned

Amount of the transaction in the currency in which it originated.

Allowable Values:

Decimal amount.

data[].currency_conversion.network.original_currency_code

string
Conditionally returned

Currency type of the origination currency.

Allowable Values:

Valid three-digit ISO 4217 currency code

data[].currency_conversion.network.settlement_data

object
Conditionally returned

Contains information from the card network about currency conversion at the time of settlement, including the original currency of the transaction, the amount of the transaction in the original currency, and the conversion rate.

Allowable Values:

Existing settlement_data object

data[].currency_conversion.network.settlement_data.amount

decimal
Conditionally returned

The settled amount.

Allowable Values:

Format: 0.00

data[].currency_conversion.network.settlement_data.conversion_rate

decimal
Conditionally returned

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
Conditionally returned

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
Conditionally returned

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:

Existing digital_wallet_token object

data[].digital_wallet_token.address_verification

object
Conditionally returned

Contains address verification information.

Allowable Values:

Existing address_verification object

data[].digital_wallet_token.address_verification.name

string
Conditionally returned

The name of the cardholder.

Allowable Values:

40 char max

data[].digital_wallet_token.address_verification.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].digital_wallet_token.address_verification.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].digital_wallet_token.address_verification.zip

string
Conditionally returned

ZIP code.

Allowable Values:

10 char max

data[].digital_wallet_token.card_token

string
Conditionally returned

Unique identifier of the card.

Allowable Values:

Existing card token

data[].digital_wallet_token.created_time

datetime
Conditionally returned

Date and time when the digital wallet token object was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].digital_wallet_token.device

object
Conditionally returned

Contains information related to the device being provisioned.

Allowable Values:

Existing device object

data[].digital_wallet_token.device.device_id

string
Conditionally returned

Identity number of the device.

Allowable Values:

20 char max

data[].digital_wallet_token.device.ip_address

string
Conditionally returned

Device’s IP address.

Allowable Values:

IP address format, 50 char max

data[].digital_wallet_token.device.language_code

string
Conditionally returned

Language the device is configured to use.

Allowable Values:

50 char max

data[].digital_wallet_token.device.location

string
Conditionally returned

Geographic coordinates of the device.

Allowable Values:

Latitude and longitude in DDD.DD/DDD.DD format.

NOTE: Both the longitude and latitude are prefixed with either a + or - symbol, for example: +42.29/-71.07.

That also allows us to finish the sentence with a full stop without confusing the reader.

data[].digital_wallet_token.device.name

string
Conditionally returned

Name of the device.

Allowable Values:

50 char max

data[].digital_wallet_token.device.phone_number

string
Conditionally returned

Device’s telephone number.

Allowable Values:

50 char max

data[].digital_wallet_token.device.token

string
Conditionally returned

Unique identifier of the device object.

Allowable Values:

36 char max

data[].digital_wallet_token.device.type

string
Conditionally returned

Type of device being provisioned.

Allowable Values:

MOBILE_PHONE, WATCH, TABLET, MOBILE_PHONE_OR_TABLET, VEHICLE, APPLIANCE, LAPTOP, GAMING_DEVICE, UNKNOWN

data[].digital_wallet_token.fulfillment_status

string
Conditionally returned

Digital wallet token’s provisioning status.

For fulfillment status descriptions, see Create Digital Wallet Token Transition.

Allowable Values:

DECISION_RED, DECISION_YELLOW, DECISION_GREEN, REJECTED, PROVISIONED

data[].digital_wallet_token.issuer_eligibility_decision

string
Conditionally returned

The Marqeta platform’s decision as to whether the digital wallet token should be provisioned.

  • 0000 – The token should be provisioned.

  • token.activation.verification.required – Provisioning is pending; further action is required for completion.

For all other values, check the value of the fulfillment_status field to definitively ascertain the provisioning outcome.

NOTE: The value invalid.cid indicates an invalid CVV2 number.

Allowable Values:

0000, cardaccount.verified, card.suspicious, token.activation.verification.required, token.activation-request.decline, card.not.active, invalid.cid, card.expired, card.suspended, cardholder.not.active

data[].digital_wallet_token.last_modified_time

datetime
Conditionally returned

Date and time when the digital wallet token object was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].digital_wallet_token.metadata

object
Conditionally returned

Contains additional information about the digital wallet token.

Allowable Values:

Existing digital_wallet_token_metadata object

data[].digital_wallet_token.metadata.cardproduct_preferred_notification_language

string
Conditionally returned

The language specified in the config.transaction_controls.notification_language field of the card product: ces (Czech), deu (German), eng (English), fra (French), ita (Italian), pol (Polish), spa (Spanish), swe (Swedish)

Allowable Values:

ces, deu, eng, fra, ita, pol, spa, swe

data[].digital_wallet_token.metadata.issuer_product_config_id

string
Conditionally returned

The unique identifier of the product configuration on the Marqeta platform.

Allowable Values:

255 char max

data[].digital_wallet_token.state

string
Conditionally returned

State of the digital wallet token.

For state descriptions, see Transitioning Token States.

Allowable Values:

REQUESTED, REQUEST_DECLINED, ACTIVE, SUSPENDED, TERMINATED

data[].digital_wallet_token.state_reason

string
Conditionally returned

Reason why the digital wallet token transitioned to its current state.

Allowable Values:

255 char max

data[].digital_wallet_token.token

string
Conditionally returned

Unique identifier of the digital wallet token.

Allowable Values:

Existing digital wallet token.

data[].digital_wallet_token.token_service_provider

object
Conditionally returned

Contains information held and provided by the token service provider (card network).

Allowable Values:

Existing token_service_provider object

data[].digital_wallet_token.token_service_provider.correlation_id

string
Conditionally returned

The unique value representing a tokenization request (Mastercard only).

Allowable Values:

Existing correlation identifier

data[].digital_wallet_token.token_service_provider.pan_reference_id

string
Returned

Unique identifier of the digital wallet token PAN within the card network.

Allowable Values:

Existing PAN Reference ID

data[].digital_wallet_token.token_service_provider.token_assurance_level

string
Conditionally returned

(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
Conditionally returned

Digital wallet’s decision as to whether the digital wallet token should be provisioned.

Allowable Values:

DECISION_RED, DECISION_YELLOW, DECISION_GREEN

data[].digital_wallet_token.token_service_provider.token_expiration

string
Conditionally returned

Expiration date of the digital wallet token.

Allowable Values:

Format: MMyy

data[].digital_wallet_token.token_service_provider.token_pan

string
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Unique numerical identifier of the token requestor within the card network. These ID numbers map to token_requestor_name field values as follows:

Mastercard

  • 50110030273 – APPLE_PAY

  • 50120834693 – ANDROID_PAY

  • 50139059239 – SAMSUNG_PAY

Visa

  • 40010030273 – APPLE_PAY

  • 40010075001 – ANDROID_PAY

  • 40010043095 – SAMSUNG_PAY

  • 40010075196 – MICROSOFT_PAY

  • 40010075338 – VISA_CHECKOUT

  • 40010075449 – FACEBOOK

  • 40010075839 – NETFLIX

  • 40010077056 – FITBIT_PAY

  • 40010069887 – GARMIN_PAY

Allowable Values:

11 char max

Example Values: * Mastercard – 50110030273, 50120834693, 50139059239 * Visa – 40010030273, 40010075001, 40010075338, 40010075449, 40010075839, 40010043095

data[].digital_wallet_token.token_service_provider.token_requestor_name

string
Conditionally returned

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: * MastercardAPPLE_PAY, ANDROID_PAY, SAMSUNG_PAY * VisaAPPLE_PAY, ANDROID_PAY, SAMSUNG_PAY, MICROSOFT_PAY, VISA_CHECKOUT, FACEBOOK, NETFLIX, FITBIT_PAY, GARMIN_PAY

data[].digital_wallet_token.token_service_provider.token_score

string
Conditionally returned

Token score assigned by the digital wallet.

Allowable Values:

25 char max

data[].digital_wallet_token.token_service_provider.token_type

string
Conditionally returned

Type of the digital wallet token.

Allowable Values:

MERCHANT_CARD_ON_FILE, DEVICE_SECURE_ELEMENT, DEVICE_CLOUD_BASED, ECOMMERCE_DIGITAL_WALLET

data[].digital_wallet_token.user

object
Conditionally returned

Contains information about a cardholder.

Allowable Values:

Existing user object

data[].digital_wallet_token.user.account_holder_group_token

string
Conditionally returned

Associates the specified account holder group with the cardholder.

Allowable Values:

36 char max

data[].digital_wallet_token.user.active

boolean
Conditionally returned

Specifies if the cardholder is in the ACTIVE state on the Marqeta platform.

Allowable Values:

true, false

data[].digital_wallet_token.user.address1

string
Conditionally returned

Cardholder’s address.

Allowable Values:

255 char max

data[].digital_wallet_token.user.address2

string
Conditionally returned

Additional address information for the cardholder.

Allowable Values:

255 char max

data[].digital_wallet_token.user.authentication

object
Conditionally returned

Contains the cardholder’s email address and password information.

Allowable Values:

Valid authentication object

data[].digital_wallet_token.user.authentication.email_verified

boolean
Conditionally returned

Specifies whether the email address has been verified.

Allowable Values:

true, false

data[].digital_wallet_token.user.authentication.email_verified_time

datetime
Conditionally returned

The date and time when the email address was verified.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].digital_wallet_token.user.authentication.last_password_update_channel

string
Conditionally returned

Specifies the channel through which the password was last changed.

Allowable Values:

USER_CHANGE, USER_RESET

data[].digital_wallet_token.user.authentication.last_password_update_time

datetime
Conditionally returned

The date and time when the password was last changed.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].digital_wallet_token.user.birth_date

string
Conditionally returned

Cardholder’s date of birth.

Allowable Values:

Format: yyyy-MM-dd

data[].digital_wallet_token.user.business_token

string
Conditionally returned

The unique identifier of the business resource.

Allowable Values:

Existing business token

data[].digital_wallet_token.user.city

string
Conditionally returned

City where the cardholder resides.

Allowable Values:

40 char max

data[].digital_wallet_token.user.company

string
Conditionally returned

Company name.

Allowable Values:

255 char max

data[].digital_wallet_token.user.corporate_card_holder

boolean
Conditionally returned

Specifies if the cardholder holds a corporate card.

Allowable Values:

true, false

data[].digital_wallet_token.user.country

string
Conditionally returned

Country where the cardholder resides.

Allowable Values:

40 char max

data[].digital_wallet_token.user.created_time

datetime
Returned

The date and time when the resource was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].digital_wallet_token.user.email

string
Conditionally returned

Valid email address of the cardholder.

Allowable Values:

1–255 chars

data[].digital_wallet_token.user.first_name

string
Conditionally returned

Cardholder’s first name.

Allowable Values:

40 char max

data[].digital_wallet_token.user.gender

string
Conditionally returned

Cardholder’s gender.

Allowable Values:

F, M

data[].digital_wallet_token.user.honorific

string
Conditionally returned

Cardholder’s title or prefix: Ms., Mr., Miss, Mrs., and so on.

Allowable Values:

10 char max

data[].digital_wallet_token.user.id_card_expiration_date

string
Conditionally returned

The expiration date of the cardholder’s identification card.

Allowable Values:

Format: yyyy-MM-dd

data[].digital_wallet_token.user.id_card_number

string
Conditionally returned

The cardholder’s identification card number.

Allowable Values:

255 char max

data[].digital_wallet_token.user.identifications

array of objects
Conditionally returned

One or more objects containing identifications associated with the cardholder.

Allowable Values:

Valid identifications array

data[].digital_wallet_token.user.identifications[].expiration_date

string
Conditionally returned

The expiration date for the form of identification, if applicable.

Allowable Values:

Format: yyyy-MM-dd

data[].digital_wallet_token.user.identifications[].type

string
Conditionally returned

The form of identification.

Allowable Values:

SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE

data[].digital_wallet_token.user.identifications[].value

string
Conditionally returned

The identification number associated with the form of identification.

Allowable Values:

255 char max

data[].digital_wallet_token.user.ip_address

string
Conditionally returned

Cardholder’s IP address.

Allowable Values:

39 char max

data[].digital_wallet_token.user.last_modified_time

datetime
Returned

The date and time when the resource was last updated, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].digital_wallet_token.user.last_name

string
Conditionally returned

Cardholder’s last name.

Allowable Values:

40 char max

data[].digital_wallet_token.user.metadata

object
Conditionally returned

Associates any additional metadata you provide with the cardholder.

Allowable Values:

You can define the names and values of up to 20 fields in the format "my_name_1": "my_value_1".

data[].digital_wallet_token.user.middle_name

string
Conditionally returned

Cardholder’s middle name.

Allowable Values:

40 char max

data[].digital_wallet_token.user.nationality

string
Conditionally returned

Cardholder’s nationality.

Allowable Values:

255 char max

data[].digital_wallet_token.user.notes

string
Conditionally returned

Any additional information pertaining to the cardholder.

Allowable Values:

255 char max

data[].digital_wallet_token.user.parent_token

string
Conditionally returned

The unique identifier of a user or business already in the system.

Allowable Values:

1–36 chars

data[].digital_wallet_token.user.passport_expiration_date

string
Conditionally returned

The expiration date of the cardholder’s passport.

Allowable Values:

Format: yyyy-MM-dd

data[].digital_wallet_token.user.passport_number

string
Conditionally returned

Cardholder’s passport number.

Allowable Values:

40 char max

data[].digital_wallet_token.user.password

string
Conditionally returned

Cardholder’s user account password on the Marqeta platform.

Allowable Values:

1–255 chars

data[].digital_wallet_token.user.phone

string
Conditionally returned

Cardholder’s telephone number.

Allowable Values:

255 char max

data[].digital_wallet_token.user.postal_code

string
Conditionally returned

Postal code of the cardholder’s address.

Allowable Values:

10 char max

data[].digital_wallet_token.user.ssn

string
Conditionally returned

The cardholder’s Social Security Number.

Allowable Values:

Nine digits only, no delimiters.

data[].digital_wallet_token.user.state

string
Conditionally returned

State in which the cardholder resides.

Allowable Values:

2 char max

data[].digital_wallet_token.user.status

string
Conditionally returned

Specifies the status of the cardholder on the Marqeta platform.

Allowable Values:

UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED

data[].digital_wallet_token.user.token

string
Conditionally returned

The unique identifier of the cardholder.

Allowable Values:

1–36 chars

data[].digital_wallet_token.user.uses_parent_account

boolean
Conditionally returned

Indicates whether the child shares balances with the parent (true), or the child’s balances are independent of the parent (false).

Allowable Values:

true, false

data[].digital_wallet_token.user.zip

string
Conditionally returned

ZIP code of the cardholder’s address.

Allowable Values:

10 char max

data[].digital_wallet_token.wallet_provider_profile

object
Conditionally returned

Contains information held and provided by the digital wallet provider.

Allowable Values:

Existing wallet_provider_profile object

data[].digital_wallet_token.wallet_provider_profile.account

object
Conditionally returned

Contains information related to the cardholder and provided by the digital wallet provider.

Allowable Values:

Existing account object

data[].digital_wallet_token.wallet_provider_profile.account.email_address

string
Conditionally returned

Digital wallet provider’s email address for the cardholder.

Allowable Values:

255 char max

data[].digital_wallet_token.wallet_provider_profile.account.id

string
Conditionally returned

Digital wallet provider’s identity number for the cardholder.

Allowable Values:

20 char max

data[].digital_wallet_token.wallet_provider_profile.account.score

string
Conditionally returned

Score from the digital wallet provider.

Allowable Values:

50 char max

data[].digital_wallet_token.wallet_provider_profile.device_score

string
Conditionally returned

Score from the device.

Allowable Values:

50 char max

data[].digital_wallet_token.wallet_provider_profile.pan_source

string
Conditionally returned

Source from which the digital wallet provider obtained the card PAN.

Allowable Values:

KEY_ENTERED, ON_FILE, MOBILE_BANKING_APP

data[].digital_wallet_token.wallet_provider_profile.reason_code

string
Conditionally returned

Reason for the wallet provider’s provisioning decision.

  • 01 – Cardholder’s wallet account is too new relative to launch.

  • 02 – Cardholder’s wallet account is too new relative to provisioning request.

  • 03 – Cardholder’s wallet account/card pair is newer than date threshold.

  • 04 – Changes made to account data within the account threshold.

  • 05 – Suspicious transactions linked to this account.

  • 06 – Account has not had activity in the last year.

  • 07 – Suspended cards in the secure element.

  • 08 – Device was put in lost mode in the last seven days for longer than the duration threshold.

  • 09 – The number of provisioning attempts on this device in 24 hours exceeds threshold.

  • 0A – There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours.

  • 0B – The card provisioning attempt contains a distinct name in excess of the threshold.

  • 0C – The device score is less than 3.

  • 0D – The account score is less than 4.

  • 0E – Device provisioning location outside of the cardholder’s wallet account home country.

  • 0G – Suspect fraud.

Allowable Values:

01, 02, 03, 04, 05, 06, 07, 08, 09, 0A, 0B, 0C, 0D, 0E, 0G

data[].digital_wallet_token.wallet_provider_profile.recommendation_reasons

array of strings
Conditionally returned

An array of recommendation reasons from the digital wallet provider.

Allowable Values:

One or more recommendation reasons

data[].digital_wallet_token.wallet_provider_profile.risk_assessment

object
Conditionally returned

Contains the digital wallet provider’s risk assessment for provisioning the digital wallet token.

Allowable Values:

Existing risk_assessment object

data[].digital_wallet_token.wallet_provider_profile.risk_assessment.score

string
Conditionally returned

Wallet provider’s decision as to whether the digital wallet token should be provisioned.

Allowable Values:

DECISION_RED, DECISION_YELLOW, DECISION_GREEN

data[].digital_wallet_token.wallet_provider_profile.risk_assessment.version

string
Conditionally returned

Wallet provider’s risk assessment version.

Allowable Values:

Version information, as provided by the wallet provider

data[].direct_deposit

object
Conditionally returned

Contains information about a direct deposit.

Allowable Values:

Existing direct_deposit object

data[].direct_deposit.amount

decimal
Conditionally returned

Amount being debited or credited.

Allowable Values:

Format: 0.00

data[].direct_deposit.business_token

string
Conditionally returned

The unique identifier of the business account holder.

Allowable Values:

Existing business token

data[].direct_deposit.company_discretionary_data

string
Conditionally returned

Company-specific data provided by the direct deposit originator.

Allowable Values:

20 char max

data[].direct_deposit.company_entry_description

string
Conditionally returned

Company-specific data provided by the direct deposit originator.

Allowable Values:

20 char max

data[].direct_deposit.company_identification

string
Conditionally returned

Alphanumeric code that identifies the direct deposit originator.

Allowable Values:

10 char max

data[].direct_deposit.company_name

string
Conditionally returned

Name of the direct deposit originator.

Allowable Values:

16 char max

data[].direct_deposit.created_time

datetime
Conditionally returned

Date and time when the direct deposit account was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].direct_deposit.direct_deposit_account_token

string
Conditionally returned

The unique identifier of the direct deposit account.

Allowable Values:

Existing direct deposit account token

data[].direct_deposit.individual_identification_number

string
Conditionally returned

Accounting number by which the recipient is known to the direct deposit originator.

Allowable Values:

255 char max

data[].direct_deposit.individual_name

string
Conditionally returned

Name of the direct deposit recipient.

Allowable Values:

22 char max

data[].direct_deposit.last_modified_time

datetime
Conditionally returned

Date and time when the direct deposit account was last modified.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].direct_deposit.settlement_date

datetime
Conditionally returned

Date and time when the credit or debit is applied.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].direct_deposit.standard_entry_class_code

string
Conditionally returned

Three-letter code identifying the type of entry.

Allowable Values:

ACK, ADV, ARC, ATX, BOC, CCD, CIE, COR, CTX, DNE, ENR, IAT, MTE, POP, POS, PPD, RCK, SHR, TEL, TRC, TRX, WEB, XCK

data[].direct_deposit.state

string
Conditionally returned

Current status of the direct deposit record.

Allowable Values:

PENDING, APPLIED, REVERSED, REJECTED

data[].direct_deposit.state_reason

string
Conditionally returned

Explanation for why the direct deposit record is in the current state.

Allowable Values:

255 char max

data[].direct_deposit.state_reason_code

string
Conditionally returned

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
Conditionally returned

The unique identifier of the direct deposit record.

Allowable Values:

Existing direct deposit record token

data[].direct_deposit.type

string
Conditionally returned

Determines whether funds are being debited from or credited to the account.

Allowable Values:

CREDIT, DEBIT

data[].direct_deposit.user_token

string
Conditionally returned

The unique identifier of the user account holder.

Allowable Values:

Existing user token

data[].dispute

object
Conditionally returned

Contains information about a disputed transaction.

Allowable Values:

Existing dispute object

data[].dispute.case_management_identifier

string
Conditionally returned

The unique identifier of the dispute case.

Allowable Values:

255 char max

data[].dispute.reason

string
Conditionally returned

The reason for the dispute.

Allowable Values:

255 char max

data[].duration

integer
Conditionally returned

Duration of the transaction on Marqeta’s servers, in milliseconds.

Allowable Values:

Any integer

data[].enhanced_data_token

string
Conditionally returned

The enhanced commercial card data token for the transaction.

Allowable Values:

255 char max

data[].fee

object
Conditionally returned

Contains details about the fee.

Allowable Values:

Valid fee object

data[].fee.active

boolean
Returned

Indicates whether the fee is active.

Allowable Values:

true, false

data[].fee.amount

decimal
Returned

The amount of the fee.

Allowable Values:

Format: 0.00

data[].fee.created_time

datetime
Returned

The date and time when the fees object was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].fee.currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

Valid three-digit ISO 4217 currency code

data[].fee.last_modified_time

datetime
Returned

The date and time when the fees object was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].fee.name

string
Returned

The name of the fee request.

Allowable Values:

50 char max

data[].fee.real_time_assessment

object
Conditionally returned

Controls the assessment of real-time fees.

Allowable Values:

Valid real_time_fee_assessment object

data[].fee.real_time_assessment.domestic_enabled

boolean
Conditionally returned

Enables fee assessments where the origin of the transaction acquirer is inside the US.

Allowable Values:

true, false

Default Value
false

data[].fee.real_time_assessment.international_enabled

boolean
Conditionally returned

Enables fee assessments where the origin of the transaction acquirer is outside the US.

Allowable Values:

true, false

Default Value
false

data[].fee.real_time_assessment.transaction_type

string
Conditionally returned

Indicates the type of transactions on which the fee is assessed.

Allowable Values:

authorization, pindebit.atm.withdrawal, pindebit

data[].fee.tags

string
Conditionally returned

Descriptive metadata about the fee.

Allowable Values:

255 char max

data[].fee.token

string
Returned

The unique identifier of the fees object.

Allowable Values:

Existing fees object token

data[].fee_transfer

object
Conditionally returned

Contains information about a fee transfer, including the amount, currency code, and user or business token.

Allowable Values:

Existing fee_transfer object

data[].fee_transfer.business_token

string
Returned

Specifies the business account holder to which the fee applies.

Allowable Values:

1–36 chars

data[].fee_transfer.created_time

datetime
Returned

The date and time when the fee_transfer object was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].fee_transfer.fees

array of objects
Returned

Contains attributes that define characteristics of one or more fees.

Allowable Values:

An array of existing fee_detail objects

data[].fee_transfer.fees[].fee

object
Returned

Contains details about the fee.

Allowable Values:

Valid fee object

data[].fee_transfer.fees[].fee.active

boolean
Returned

Indicates whether the fee is active.

Allowable Values:

true, false

data[].fee_transfer.fees[].fee.amount

decimal
Returned

The amount of the fee.

Allowable Values:

Format: 0.00

data[].fee_transfer.fees[].fee.created_time

datetime
Returned

The date and time when the fees object was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].fee_transfer.fees[].fee.currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

Valid three-digit ISO 4217 currency code

data[].fee_transfer.fees[].fee.last_modified_time

datetime
Returned

The date and time when the fees object was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].fee_transfer.fees[].fee.name

string
Returned

The name of the fee request.

Allowable Values:

50 char max

data[].fee_transfer.fees[].fee.real_time_assessment

object
Conditionally returned

Controls the assessment of real-time fees.

Allowable Values:

Valid real_time_fee_assessment object

data[].fee_transfer.fees[].fee.real_time_assessment.domestic_enabled

boolean
Conditionally returned

Enables fee assessments where the origin of the transaction acquirer is inside the US.

Allowable Values:

true, false

Default Value
false

data[].fee_transfer.fees[].fee.real_time_assessment.international_enabled

boolean
Conditionally returned

Enables fee assessments where the origin of the transaction acquirer is outside the US.

Allowable Values:

true, false

Default Value
false

data[].fee_transfer.fees[].fee.real_time_assessment.transaction_type

string
Conditionally returned

Indicates the type of transactions on which the fee is assessed.

Allowable Values:

authorization, pindebit.atm.withdrawal, pindebit

data[].fee_transfer.fees[].fee.tags

string
Conditionally returned

Descriptive metadata about the fee.

Allowable Values:

255 char max

data[].fee_transfer.fees[].fee.token

string
Returned

The unique identifier of the fees object.

Allowable Values:

Existing fees object token

data[].fee_transfer.fees[].memo

string
Conditionally returned

Additional text that describes the fee transfer.

Allowable Values:

1–99 chars

data[].fee_transfer.fees[].tags

string
Conditionally returned

Descriptive metadata about the fee.

Allowable Values:

255 char max

data[].fee_transfer.fees[].token

string
Returned

The unique identifier of the fee.

Allowable Values:

1–36 chars

data[].fee_transfer.fees[].transaction_token

string
Returned

The unique identifier of the fee transaction.

Allowable Values:

36 char max

data[].fee_transfer.tags

string
Conditionally returned

Metadata about the transfer.

Allowable Values:

255 char max

data[].fee_transfer.token

string
Returned

The unique identifier of the fee transfer.

Allowable Values:

1–36 chars

data[].fee_transfer.user_token

string
Returned

Specifies the user account holder to which the fee applies.

Allowable Values:

1–36 chars

data[].fees

array of objects
Conditionally returned

List of fees associated with the transaction.

This array is returned if it exists in the resource.

Allowable Values:

Array of existing fees objects

data[].fees[].amount

decimal
Conditionally returned

The amount of the network fee.

Allowable Values:

Format: 0.00

data[].fees[].credit_debit

string
Conditionally returned

Indicates whether the fee is a credit or a debit.

  • C indicates a credit

  • D indicates a debit

Allowable Values:

C, D

data[].fees[].type

string
Conditionally returned

The type of fee assessed by the card network.

Allowable Values:

ISSUER_FEE, SWITCH_FEE, PINDEBIT_ASSOC_FEE, ACQUIRER_FEE, INTERCHANGE_FEE, CUR_CONV_CARDHOLDER_FEE, CUR_CONV_ISSUER_FEE, CROSS_BORDER_ISSUER_FEE

data[].fraud

object
Conditionally returned

Contains one or more fraud determinations by the card network that apply to either the transaction or the cardholder’s account.

Allowable Values:

Existing fraud object

data[].fraud.network

object
Conditionally returned

Contains network-provided information about fraud determinations.

Allowable Values:

Existing fraud.network object

data[].fraud.network.account_risk_score

string
Conditionally returned

(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
Conditionally returned

(Visa only) Unique code that describes the main driver of the account_risk_score.

Allowable Values:

255 char max

data[].fraud.network.transaction_risk_score

integer
Conditionally returned

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
Conditionally returned

(Mastercard only) Unique code that describes the main driver of the transaction_risk_score.

Allowable Values:

1-29

data[].fraud.network.transaction_risk_score_reason_description

string
Conditionally returned

(Mastercard only) Description of the transaction_risk_score_reason_code.

Allowable Values:

255 char max

data[].from_account

string
Conditionally returned

Specifies the account type for ATM transactions.

Allowable Values:

DEFAULT, OTHER, SAVINGS, CHECKING, CREDIT_CARD, CREDIT_LINE, CORPORATE, CREDIT_FACILITY, UNIVERSAL, MONEY_MARKET_INVESTMENT, STORED_VALUE, REVOLVING_LOAN, MORTGAGE, INSTALLMENT_LOAN, CHILD_CARE_BENEFIT, CASH_BENEFIT, UNKNOWN, FOOD_STAMP

data[].gpa

object
Conditionally returned

Returns general purpose account (GPA) balances for a user or business.

Allowable Values:

Valid gpa object

data[].gpa.available_balance

decimal
Returned

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:

Format: 0.00

data[].gpa.balances

object
Returned

Contains GPA balance information, organized by currency code.

Allowable Values:

Valid balances object

data[].gpa.cached_balance

decimal
Returned

Not currently in use.

Allowable Values:

Not applicable

data[].gpa.credit_balance

decimal
Returned

Not currently in use.

Allowable Values:

Not applicable

data[].gpa.currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

Valid three-digit ISO 4217 currency code.

data[].gpa.impacted_amount

decimal
Conditionally returned

Balance change based on the amount of the transaction.

Allowable Values:

Format: 0.00

data[].gpa.last_updated_time

datetime
Returned

The date and time when the resource was last updated, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa.ledger_balance

decimal
Returned

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:

Format: 0.00

data[].gpa.pending_credits

decimal
Returned

ACH loads that have been accepted, but for which the funding time has not yet elapsed.

Allowable Values:

Format: 0.00

data[].gpa_order

object
Conditionally returned

Contains information about a GPA order, including fees, funding sources, and addresses. See GPA Orders for more information.

Allowable Values:

Existing gpa_order object

data[].gpa_order.amount

decimal
Returned

The amount funded.

Allowable Values:

Format: 0.00

data[].gpa_order.business_token

string
Conditionally returned

The unique identifier of the business.

This field is returned if it exists in the resource.

Allowable Values:

Existing business_token

data[].gpa_order.created_time

datetime
Returned

The date and time when the GPA order was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order.currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

Valid three-digit ISO 4217 currency code

data[].gpa_order.fees

array of objects
Conditionally returned

List of fees associated with the funding transaction.

This array is returned if it exists in the resource.

Allowable Values:

Existing fee_model objects

data[].gpa_order.fees[].fee

object
Returned

Contains details about the fee.

Allowable Values:

Valid fee object

data[].gpa_order.fees[].fee.active

boolean
Returned

Indicates whether the fee is active.

Allowable Values:

true, false

data[].gpa_order.fees[].fee.amount

decimal
Returned

The amount of the fee.

Allowable Values:

Format: 0.00

data[].gpa_order.fees[].fee.created_time

datetime
Returned

The date and time when the fees object was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order.fees[].fee.currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

Valid three-digit ISO 4217 currency code

data[].gpa_order.fees[].fee.last_modified_time

datetime
Returned

The date and time when the fees object was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order.fees[].fee.name

string
Returned

The name of the fee request.

Allowable Values:

50 char max

data[].gpa_order.fees[].fee.real_time_assessment

object
Conditionally returned

Controls the assessment of real-time fees.

Allowable Values:

Valid real_time_fee_assessment object

data[].gpa_order.fees[].fee.real_time_assessment.domestic_enabled

boolean
Conditionally returned

Enables fee assessments where the origin of the transaction acquirer is inside the US.

Allowable Values:

true, false

Default Value
false

data[].gpa_order.fees[].fee.real_time_assessment.international_enabled

boolean
Conditionally returned

Enables fee assessments where the origin of the transaction acquirer is outside the US.

Allowable Values:

true, false

Default Value
false

data[].gpa_order.fees[].fee.real_time_assessment.transaction_type

string
Conditionally returned

Indicates the type of transactions on which the fee is assessed.

Allowable Values:

authorization, pindebit.atm.withdrawal, pindebit

data[].gpa_order.fees[].fee.tags

string
Conditionally returned

Descriptive metadata about the fee.

Allowable Values:

255 char max

data[].gpa_order.fees[].fee.token

string
Returned

The unique identifier of the fees object.

Allowable Values:

Existing fees object token

data[].gpa_order.fees[].memo

string
Conditionally returned

Additional text that describes the fee transfer.

Allowable Values:

1–99 chars

data[].gpa_order.fees[].tags

string
Conditionally returned

Descriptive metadata about the fee.

Allowable Values:

255 char max

data[].gpa_order.fees[].token

string
Returned

The unique identifier of the fee.

Allowable Values:

1–36 chars

data[].gpa_order.fees[].transaction_token

string
Returned

The unique identifier of the fee transaction.

Allowable Values:

36 char max

data[].gpa_order.funding

object
Returned

Contains funding information for the transaction, including funding amount, type, and time.

Allowable Values:

Valid funding object

data[].gpa_order.funding.amount

decimal
Conditionally returned

Amount of funds loaded into the GPA.

Allowable Values:

Format: 0.00

data[].gpa_order.funding.gateway_log

object
Conditionally returned

Contains information from the Just-in-Time (JIT) Funding gateway in response to a funding request.

Allowable Values:

Valid gateway_log object

data[].gpa_order.funding.gateway_log.duration

integer
Conditionally returned

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
Returned

Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out.

Allowable Values:

Approved or completed successfully, Declined by gateway, Operation timeout

data[].gpa_order.funding.gateway_log.order_number

string
Returned

Customer order number, same value as transaction.token.

Allowable Values:

Existing transaction.token value

data[].gpa_order.funding.gateway_log.response

object
Conditionally returned

Contains information from the gateway in response to a funding request.

Allowable Values:

Valid gateway_response object

data[].gpa_order.funding.gateway_log.response.code

string
Returned

Code received from the gateway.

Allowable Values:

255 char max

data[].gpa_order.funding.gateway_log.response.data

object
Conditionally returned

Contains the gateway’s information about the JIT Funding transaction.

Allowable Values:

Valid jit_funding object

data[].gpa_order.funding.gateway_log.response.data.jit_funding

object
Returned

Contains the information about the JIT funding load event, in which funds are loaded into an account.

Allowable Values:

Existing jit_funding object

data[].gpa_order.funding.gateway_log.response.data.jit_funding.acting_user_token

string
Conditionally returned

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
Conditionally returned

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:

Existing address_verification object

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway

object
Conditionally returned

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:

Valid address_verification_source object

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response

object
Conditionally returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer

object
Conditionally returned

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:

Valid address_verification_source object

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response

object
Conditionally returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.request.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

data[].gpa_order.funding.gateway_log.response.data.jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

data[].gpa_order.funding.gateway_log.response.data.jit_funding.business_token

string
Conditionally returned

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
Conditionally returned

The reason the transaction was declined.

Allowable Values:

INVALID_AMOUNT, INSUFFICIENT_FUNDS, TRANSACTION_NOT_PERMITTED, SUSPECTED_FRAUD, AMOUNT_LIMIT_EXCEEDED, TRANSACTION_COUNT_LIMIT_EXCEEDED, DUPLICATE_TRANSACTION, INVALID_MERCHANT, INVALID_CARD, NO_CREDIT_ACCOUNT, EXPIRED_CARD, NO_CHECKING_ACCOUNT, NO_SAVINGS_ACCOUNT, STOP_PAYMENT, REVOCATION_AUTHORIZATION_ORDER, REVOCATION_ALL_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, CLOSED_ACCOUNT

data[].gpa_order.funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens

array of strings
Conditionally returned

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
Conditionally returned

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
Returned

JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method.

Allowable Values:

pgfs.authorization, pgfs.balanceinquiry, pgfs.authorization.incremental, pgfs.authorization.capture, pgfs.authorization.reversal, pgfs.auth_plus_capture, pgfs.refund, pgfs.force_capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.directdeposit.credit, pgfs.directdeposit.debit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit.reversal, pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.auth_plus_capture.standin, pgfs.authorization.standin, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.refund.authorization, pgfs.refund.authorization.reversalpgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.authorization.account_verification

data[].gpa_order.funding.gateway_log.response.data.jit_funding.original_jit_funding_token

string
Conditionally returned

Token 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
Conditionally returned

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
Returned

Existing JIT Funding token matching the funding.gateway_log.transaction_id field of the associated general purpose account (GPA) order. Note that the transaction_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction_id field matches the token of the most recent message.

Allowable Values:

36 char max

data[].gpa_order.funding.gateway_log.response.data.jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

data[].gpa_order.funding.gateway_log.timed_out

boolean
Conditionally returned

Whether the gateway sent a response (true) or timed out (false).

Allowable Values:

true, false

data[].gpa_order.funding.gateway_log.transaction_id

string
Returned

Customer-defined identifier for the transaction.

Allowable Values:

255 char max

data[].gpa_order.funding.source

object
Returned

Contains funding source information for the transaction, including the funding type and time.

Allowable Values:

Existing funding_source object

data[].gpa_order.funding.source.active

boolean
Returned

Whether the funding source is active.

Allowable Values:

true, false

data[].gpa_order.funding.source.created_time

datetime
Returned

Date and time when the funding source was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order.funding.source.is_default_account

boolean
Returned

Whether the GPA order unload’s funding source is the default funding account.

Allowable Values:

true, false

data[].gpa_order.funding.source.last_modified_time

datetime
Returned

Date and time when the funding source was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order.funding.source.token

string
Returned

Unique identifier of the funding source.

Allowable Values:

Format: UUID

data[].gpa_order.funding.source.type

string
Returned

Funding type of the funding source.

Allowable Values:

ach, paymentcard

data[].gpa_order.funding.source_address

object
Conditionally returned

Contains information about the billing address of the funding source.

Allowable Values:

Valid funding_source_address object

data[].gpa_order.funding.source_address.active

boolean
Conditionally returned

Whether the address is active.

Allowable Values:

true, false

data[].gpa_order.funding.source_address.address_1

string
Returned

Street address of the funding source.

Allowable Values:

255 char max

data[].gpa_order.funding.source_address.address_2

string
Conditionally returned

Additional address information for the funding source.

Allowable Values:

255 char max

data[].gpa_order.funding.source_address.business_token

string
Conditionally returned

Unique identifier of the business account holder associated with the address.

Allowable Values:

1–36 chars

data[].gpa_order.funding.source_address.city

string
Returned

City of the funding source.

Allowable Values:

40 char max

data[].gpa_order.funding.source_address.country

string
Returned

Country of the funding source.

Allowable Values:

1–40 chars

data[].gpa_order.funding.source_address.created_time

datetime
Returned

Date and time when the address was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order.funding.source_address.first_name

string
Returned

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
Conditionally returned

Whether this address is the default address used by the funding source.

Allowable Values:

true, false

data[].gpa_order.funding.source_address.last_modified_time

datetime
Returned

Date and time when the address was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order.funding.source_address.last_name

string
Returned

Last name of the account holder associated with the funding source.

Allowable Values:

40 char max

data[].gpa_order.funding.source_address.phone

string
Conditionally returned

Phone number of the funding source.

Allowable Values:

255 char max

data[].gpa_order.funding.source_address.postal_code

string
Returned

Postal code of the funding source.

Allowable Values:

10 char max

data[].gpa_order.funding.source_address.state

string
Returned

Two-character state, province, or territorial abbreviation.

Allowable Values:

2 char max

data[].gpa_order.funding.source_address.token

string
Returned

Unique identifier of the funding_source_address object.

Allowable Values:

1–36 chars

data[].gpa_order.funding.source_address.user_token

string
Conditionally returned

Unique identifier of the user account holder associated with the address.

Allowable Values:

1–36 chars

data[].gpa_order.funding.source_address.zip

string
Returned

United States ZIP code of the funding source.

Allowable Values:

10 char max

data[].gpa_order.funding_source_address_token

string
Conditionally returned

Identifies the funding source address to use for this order.

Allowable Values:

Existing funding_source_address token

data[].gpa_order.funding_source_token

string
Returned

Identifies the funding source to use for this order.

Allowable Values:

Existing funding_source token

data[].gpa_order.gateway_message

string
Conditionally returned

Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out.

This field is returned if it exists in the resource.

Allowable Values:

Approved or completed successfully, Declined by gateway, Operation timeout

data[].gpa_order.gateway_token

integer
Conditionally returned

Unique identifier of the JIT Funding request and response.

This field is returned if it exists in the resource.

Allowable Values:

Existing gateway_token

data[].gpa_order.jit_funding

object
Conditionally returned

Contains the information about the JIT funding load event, in which funds are loaded into an account.

Allowable Values:

Existing jit_funding object

data[].gpa_order.jit_funding.acting_user_token

string
Conditionally returned

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
Conditionally returned

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:

Existing address_verification object

data[].gpa_order.jit_funding.address_verification.gateway

object
Conditionally returned

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:

Valid address_verification_source object

data[].gpa_order.jit_funding.address_verification.gateway.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order.jit_funding.address_verification.gateway.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order.jit_funding.address_verification.gateway.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order.jit_funding.address_verification.gateway.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order.jit_funding.address_verification.gateway.response

object
Conditionally returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].gpa_order.jit_funding.address_verification.gateway.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].gpa_order.jit_funding.address_verification.gateway.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].gpa_order.jit_funding.address_verification.gateway.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].gpa_order.jit_funding.address_verification.issuer

object
Conditionally returned

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:

Valid address_verification_source object

data[].gpa_order.jit_funding.address_verification.issuer.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order.jit_funding.address_verification.issuer.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order.jit_funding.address_verification.issuer.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order.jit_funding.address_verification.issuer.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order.jit_funding.address_verification.issuer.response

object
Conditionally returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].gpa_order.jit_funding.address_verification.issuer.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].gpa_order.jit_funding.address_verification.issuer.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].gpa_order.jit_funding.address_verification.issuer.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].gpa_order.jit_funding.address_verification.request

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order.jit_funding.address_verification.request.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order.jit_funding.address_verification.request.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order.jit_funding.address_verification.request.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order.jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

data[].gpa_order.jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

data[].gpa_order.jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

data[].gpa_order.jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

INVALID_AMOUNT, INSUFFICIENT_FUNDS, TRANSACTION_NOT_PERMITTED, SUSPECTED_FRAUD, AMOUNT_LIMIT_EXCEEDED, TRANSACTION_COUNT_LIMIT_EXCEEDED, DUPLICATE_TRANSACTION, INVALID_MERCHANT, INVALID_CARD, NO_CREDIT_ACCOUNT, EXPIRED_CARD, NO_CHECKING_ACCOUNT, NO_SAVINGS_ACCOUNT, STOP_PAYMENT, REVOCATION_AUTHORIZATION_ORDER, REVOCATION_ALL_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, CLOSED_ACCOUNT

data[].gpa_order.jit_funding.incremental_authorization_jit_funding_tokens

array of strings
Conditionally returned

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
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

data[].gpa_order.jit_funding.method

string
Returned

JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method.

Allowable Values:

pgfs.authorization, pgfs.balanceinquiry, pgfs.authorization.incremental, pgfs.authorization.capture, pgfs.authorization.reversal, pgfs.auth_plus_capture, pgfs.refund, pgfs.force_capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.directdeposit.credit, pgfs.directdeposit.debit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit.reversal, pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.auth_plus_capture.standin, pgfs.authorization.standin, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.refund.authorization, pgfs.refund.authorization.reversalpgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.authorization.account_verification

data[].gpa_order.jit_funding.original_jit_funding_token

string
Conditionally returned

Token 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
Conditionally returned

Customer-defined tags related to the JIT funding transaction.

Allowable Values:

255 char max

data[].gpa_order.jit_funding.token

string
Returned

Existing JIT Funding token matching the funding.gateway_log.transaction_id field of the associated general purpose account (GPA) order. Note that the transaction_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction_id field matches the token of the most recent message.

Allowable Values:

36 char max

data[].gpa_order.jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

data[].gpa_order.last_modified_time

datetime
Returned

The date and time when the GPA order was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order.memo

string
Conditionally returned

Additional descriptive text.

This field is returned if it exists in the resource.

Allowable Values:

99 char max

data[].gpa_order.response

object
Returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].gpa_order.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].gpa_order.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].gpa_order.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].gpa_order.state

string
Returned

Current status of the funding transaction.

Allowable Values:

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL

data[].gpa_order.tags

string
Conditionally returned

Comma-delimited list of tags describing the order.

This field is returned if it exists in the resource.

Allowable Values:

255 char max

data[].gpa_order.token

string
Returned

The unique identifier of the GPA order.

Allowable Values:

36 char max

data[].gpa_order.transaction_token

string
Returned

Unique identifier of the transaction being funded.

Allowable Values:

Format: UUID

data[].gpa_order.user_token

string
Conditionally returned

The unique identifier of the user.

This field is returned if it exists in the resource.

Allowable Values:

Existing user token

data[].gpa_order_unload

object
Conditionally returned

Contains information about a GPA unload order.

Allowable Values:

Existing gpa_order_unload object

data[].gpa_order_unload.amount

decimal
Returned

The amount of funds unloaded (returned to funding source).

Allowable Values:

Format: 0.00

data[].gpa_order_unload.created_time

datetime
Returned

Date and time when the GPA unload order was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order_unload.funding

object
Returned

Contains funding information for the transaction, including funding amount, type, and time.

Allowable Values:

Valid funding object

data[].gpa_order_unload.funding.amount

decimal
Conditionally returned

Amount of funds loaded into the GPA.

Allowable Values:

Format: 0.00

data[].gpa_order_unload.funding.gateway_log

object
Conditionally returned

Contains information from the Just-in-Time (JIT) Funding gateway in response to a funding request.

Allowable Values:

Valid gateway_log object

data[].gpa_order_unload.funding.gateway_log.duration

integer
Conditionally returned

Length of time in milliseconds that the gateway took to respond to a funding request.

Allowable Values:

Any integer

data[].gpa_order_unload.funding.gateway_log.message

string
Returned

Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out.

Allowable Values:

Approved or completed successfully, Declined by gateway, Operation timeout

data[].gpa_order_unload.funding.gateway_log.order_number

string
Returned

Customer order number, same value as transaction.token.

Allowable Values:

Existing transaction.token value

data[].gpa_order_unload.funding.gateway_log.response

object
Conditionally returned

Contains information from the gateway in response to a funding request.

Allowable Values:

Valid gateway_response object

data[].gpa_order_unload.funding.gateway_log.response.code

string
Returned

Code received from the gateway.

Allowable Values:

255 char max

data[].gpa_order_unload.funding.gateway_log.response.data

object
Conditionally returned

Contains the gateway’s information about the JIT Funding transaction.

Allowable Values:

Valid jit_funding object

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding

object
Returned

Contains the information about the JIT funding load event, in which funds are loaded into an account.

Allowable Values:

Existing jit_funding object

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.acting_user_token

string
Conditionally returned

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_unload.funding.gateway_log.response.data.jit_funding.address_verification

object
Conditionally returned

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:

Existing address_verification object

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway

object
Conditionally returned

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:

Valid address_verification_source object

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response

object
Conditionally returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer

object
Conditionally returned

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:

Valid address_verification_source object

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response

object
Conditionally returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.request

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.request.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.address_verification.request.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

INVALID_AMOUNT, INSUFFICIENT_FUNDS, TRANSACTION_NOT_PERMITTED, SUSPECTED_FRAUD, AMOUNT_LIMIT_EXCEEDED, TRANSACTION_COUNT_LIMIT_EXCEEDED, DUPLICATE_TRANSACTION, INVALID_MERCHANT, INVALID_CARD, NO_CREDIT_ACCOUNT, EXPIRED_CARD, NO_CHECKING_ACCOUNT, NO_SAVINGS_ACCOUNT, STOP_PAYMENT, REVOCATION_AUTHORIZATION_ORDER, REVOCATION_ALL_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, CLOSED_ACCOUNT

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens

array of strings
Conditionally returned

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_unload.funding.gateway_log.response.data.jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.method

string
Returned

JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method.

Allowable Values:

pgfs.authorization, pgfs.balanceinquiry, pgfs.authorization.incremental, pgfs.authorization.capture, pgfs.authorization.reversal, pgfs.auth_plus_capture, pgfs.refund, pgfs.force_capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.directdeposit.credit, pgfs.directdeposit.debit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit.reversal, pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.auth_plus_capture.standin, pgfs.authorization.standin, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.refund.authorization, pgfs.refund.authorization.reversalpgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.authorization.account_verification

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.original_jit_funding_token

string
Conditionally returned

Token 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_unload.funding.gateway_log.response.data.jit_funding.tags

string
Conditionally returned

Customer-defined tags related to the JIT funding transaction.

Allowable Values:

255 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.token

string
Returned

Existing JIT Funding token matching the funding.gateway_log.transaction_id field of the associated general purpose account (GPA) order. Note that the transaction_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction_id field matches the token of the most recent message.

Allowable Values:

36 char max

data[].gpa_order_unload.funding.gateway_log.response.data.jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

data[].gpa_order_unload.funding.gateway_log.timed_out

boolean
Conditionally returned

Whether the gateway sent a response (true) or timed out (false).

Allowable Values:

true, false

data[].gpa_order_unload.funding.gateway_log.transaction_id

string
Returned

Customer-defined identifier for the transaction.

Allowable Values:

255 char max

data[].gpa_order_unload.funding.source

object
Returned

Contains funding source information for the transaction, including the funding type and time.

Allowable Values:

Existing funding_source object

data[].gpa_order_unload.funding.source.active

boolean
Returned

Whether the funding source is active.

Allowable Values:

true, false

data[].gpa_order_unload.funding.source.created_time

datetime
Returned

Date and time when the funding source was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order_unload.funding.source.is_default_account

boolean
Returned

Whether the GPA order unload’s funding source is the default funding account.

Allowable Values:

true, false

data[].gpa_order_unload.funding.source.last_modified_time

datetime
Returned

Date and time when the funding source was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order_unload.funding.source.token

string
Returned

Unique identifier of the funding source.

Allowable Values:

Format: UUID

data[].gpa_order_unload.funding.source.type

string
Returned

Funding type of the funding source.

Allowable Values:

ach, paymentcard

data[].gpa_order_unload.funding.source_address

object
Conditionally returned

Contains information about the billing address of the funding source.

Allowable Values:

Valid funding_source_address object

data[].gpa_order_unload.funding.source_address.active

boolean
Conditionally returned

Whether the address is active.

Allowable Values:

true, false

data[].gpa_order_unload.funding.source_address.address_1

string
Returned

Street address of the funding source.

Allowable Values:

255 char max

data[].gpa_order_unload.funding.source_address.address_2

string
Conditionally returned

Additional address information for the funding source.

Allowable Values:

255 char max

data[].gpa_order_unload.funding.source_address.business_token

string
Conditionally returned

Unique identifier of the business account holder associated with the address.

Allowable Values:

1–36 chars

data[].gpa_order_unload.funding.source_address.city

string
Returned

City of the funding source.

Allowable Values:

40 char max

data[].gpa_order_unload.funding.source_address.country

string
Returned

Country of the funding source.

Allowable Values:

1–40 chars

data[].gpa_order_unload.funding.source_address.created_time

datetime
Returned

Date and time when the address was created, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order_unload.funding.source_address.first_name

string
Returned

First name of the account holder associated with the funding source.

Allowable Values:

40 char max

data[].gpa_order_unload.funding.source_address.is_default_address

boolean
Conditionally returned

Whether this address is the default address used by the funding source.

Allowable Values:

true, false

data[].gpa_order_unload.funding.source_address.last_modified_time

datetime
Returned

Date and time when the address was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order_unload.funding.source_address.last_name

string
Returned

Last name of the account holder associated with the funding source.

Allowable Values:

40 char max

data[].gpa_order_unload.funding.source_address.phone

string
Conditionally returned

Phone number of the funding source.

Allowable Values:

255 char max

data[].gpa_order_unload.funding.source_address.postal_code

string
Returned

Postal code of the funding source.

Allowable Values:

10 char max

data[].gpa_order_unload.funding.source_address.state

string
Returned

Two-character state, province, or territorial abbreviation.

Allowable Values:

2 char max

data[].gpa_order_unload.funding.source_address.token

string
Returned

Unique identifier of the funding_source_address object.

Allowable Values:

1–36 chars

data[].gpa_order_unload.funding.source_address.user_token

string
Conditionally returned

Unique identifier of the user account holder associated with the address.

Allowable Values:

1–36 chars

data[].gpa_order_unload.funding.source_address.zip

string
Returned

United States ZIP code of the funding source.

Allowable Values:

10 char max

data[].gpa_order_unload.funding_source_address_token

string
Conditionally returned

Identifies the funding source used for this order.

Allowable Values:

Existing funding_source_address token.

data[].gpa_order_unload.funding_source_token

string
Returned

Identifies the funding source used for this order.

Allowable Values:

Existing funding_source token

data[].gpa_order_unload.jit_funding

object
Conditionally returned

Contains the information about the JIT funding load event, in which funds are loaded into an account.

Allowable Values:

Existing jit_funding object

data[].gpa_order_unload.jit_funding.acting_user_token

string
Conditionally returned

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_unload.jit_funding.address_verification

object
Conditionally returned

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:

Existing address_verification object

data[].gpa_order_unload.jit_funding.address_verification.gateway

object
Conditionally returned

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:

Valid address_verification_source object

data[].gpa_order_unload.jit_funding.address_verification.gateway.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order_unload.jit_funding.address_verification.gateway.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order_unload.jit_funding.address_verification.gateway.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order_unload.jit_funding.address_verification.gateway.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order_unload.jit_funding.address_verification.gateway.response

object
Conditionally returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].gpa_order_unload.jit_funding.address_verification.gateway.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].gpa_order_unload.jit_funding.address_verification.gateway.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].gpa_order_unload.jit_funding.address_verification.gateway.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].gpa_order_unload.jit_funding.address_verification.issuer

object
Conditionally returned

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:

Valid address_verification_source object

data[].gpa_order_unload.jit_funding.address_verification.issuer.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order_unload.jit_funding.address_verification.issuer.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order_unload.jit_funding.address_verification.issuer.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order_unload.jit_funding.address_verification.issuer.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order_unload.jit_funding.address_verification.issuer.response

object
Conditionally returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].gpa_order_unload.jit_funding.address_verification.issuer.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].gpa_order_unload.jit_funding.address_verification.issuer.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].gpa_order_unload.jit_funding.address_verification.issuer.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].gpa_order_unload.jit_funding.address_verification.request

object
Conditionally returned

Contains address verification information.

Allowable Values:

Valid address verification information

data[].gpa_order_unload.jit_funding.address_verification.request.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].gpa_order_unload.jit_funding.address_verification.request.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].gpa_order_unload.jit_funding.address_verification.request.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].gpa_order_unload.jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

data[].gpa_order_unload.jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

data[].gpa_order_unload.jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

data[].gpa_order_unload.jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

INVALID_AMOUNT, INSUFFICIENT_FUNDS, TRANSACTION_NOT_PERMITTED, SUSPECTED_FRAUD, AMOUNT_LIMIT_EXCEEDED, TRANSACTION_COUNT_LIMIT_EXCEEDED, DUPLICATE_TRANSACTION, INVALID_MERCHANT, INVALID_CARD, NO_CREDIT_ACCOUNT, EXPIRED_CARD, NO_CHECKING_ACCOUNT, NO_SAVINGS_ACCOUNT, STOP_PAYMENT, REVOCATION_AUTHORIZATION_ORDER, REVOCATION_ALL_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, CLOSED_ACCOUNT

data[].gpa_order_unload.jit_funding.incremental_authorization_jit_funding_tokens

array of strings
Conditionally returned

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_unload.jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

data[].gpa_order_unload.jit_funding.method

string
Returned

JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method.

Allowable Values:

pgfs.authorization, pgfs.balanceinquiry, pgfs.authorization.incremental, pgfs.authorization.capture, pgfs.authorization.reversal, pgfs.auth_plus_capture, pgfs.refund, pgfs.force_capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.directdeposit.credit, pgfs.directdeposit.debit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit.reversal, pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.auth_plus_capture.standin, pgfs.authorization.standin, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.refund.authorization, pgfs.refund.authorization.reversalpgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.authorization.account_verification

data[].gpa_order_unload.jit_funding.original_jit_funding_token

string
Conditionally returned

Token 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_unload.jit_funding.tags

string
Conditionally returned

Customer-defined tags related to the JIT funding transaction.

Allowable Values:

255 char max

data[].gpa_order_unload.jit_funding.token

string
Returned

Existing JIT Funding token matching the funding.gateway_log.transaction_id field of the associated general purpose account (GPA) order. Note that the transaction_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction_id field matches the token of the most recent message.

Allowable Values:

36 char max

data[].gpa_order_unload.jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

data[].gpa_order_unload.last_modified_time

datetime
Returned

Date and time when the GPA unload order was last modified, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].gpa_order_unload.memo

string
Conditionally returned

Additional descriptive text.

Allowable Values:

99 char max

data[].gpa_order_unload.original_order_token

string
Conditionally returned

Identifies the original GPA order.

Allowable Values:

Existing GPA order token

data[].gpa_order_unload.response

object
Returned

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

Allowable Values:

Existing response object

data[].gpa_order_unload.response.additional_information

string
Conditionally returned

Information about the relevant velocity control for the transaction, if applicable.

Allowable Values:

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

data[].gpa_order_unload.response.code

string
Returned

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].gpa_order_unload.response.