token

Identifies the transaction to retrieve.

Existing transaction token.

type

Transaction event type. For more information about the type field, see the "Transaction events" section on the Event Types page.

state

Current state of the transaction. For more information about the state field, see The transaction lifecycle on the "About Transactions" page.

PENDING, CLEARED, COMPLETION, DECLINED, ERROR

identifier

Sequential identifier of the transaction.

token

Unique identifier of the transaction, formatted as a UUID.

NOTE: For subsequent related transactions, this token value appears as the preceding_related_transaction_token.

36 char max

user_token

Unique identifier of the user who owns the account that funded the transaction; subsequent related transactions retain the same user_token even if the card used to complete the transaction moves to another user.

36 char max

business_token

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

36 char max

acting_user_token

Unique identifier of the user who conducted the transaction, who can be a child user configured to share its parent’s account balance.

36 char max

card_token

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

36 char max

is_preauthorization

Indicates if the transaction is a pre-authorization.

true, false

duration

Duration of the transaction on Marqeta servers, in milliseconds.

created_time

Date and time when the Marqeta platform created the transaction entry (for example, when the platform received an incoming message for a refund).

user_transaction_time

Date and time when the user initiated the transaction (for example, when a merchant entered a refund).

settlement_date

Date and time when funds were moved for a transaction (for example, in the case of a refund, when funds were credited to the cardholder).

request_amount

Merchant-requested amount, including any fees.

amount

Amount of the transaction.

cash_back_amount

Amount of cash back requested by the card holder during the transaction, to be included in the total transaction amount.

currency_conversion

Contains information about currency conversion.

currency_conversion.network

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.

A valid currency_conversion.network object.

currency_conversion.network.original_amount

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

Decimal amount.

currency_conversion.network.conversion_rate

Returned when the transaction currency is different from the origination currency.

Conversion rate between the origination currency and the settlement currency.

Current conversion rate.

NOTE: A value of 0 or 1 indicates no conversion; the currencies are the same.

currency_conversion.network.original_currency_code

Currency type of the origination currency.

A valid three-digit ISO 4217 currency type.

currency_conversion.network.dynamic_currency_conversion

Indicates whether currency conversion was performed dynamically.

true, false

currency_conversion.network.settlement_data

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.

A valid currency_conversion.network.settlement_data object.

currency_conversion.network.settlement_data.original_amount

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

Decimal amount.

currency_conversion.network.settlement_data.conversion_rate

Returned when the transaction currency is different from the origination currency.

Conversion rate between the origination currency and the settlement currency.

Current conversion rate.

NOTE: A value of 0 or 1 indicates no conversion; the currencies are the same.

currency_conversion.network.settlement_data.original_currency_code

Currency type of the origination currency.

A valid three-digit ISO 4217 currency type.

currency_code

Currency type of the transaction.

A valid three-digit ISO 4217 currency type.

approval_code

Unique identifier assigned to a given authorization. Is printed on the receipt at point of sale.

response

Contains information about the response, including the response code and response memo.

response.code, response.memo, response.additional_information

response.code

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:

Four digits

response.memo

Information on the outcome of the attempted transaction type.

255 char max

response.additional_information

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

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.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

preceding_related_transaction_token

Returned for final transaction types.

Unique identifier of the preceding related transaction. Useful for identifying the transaction that preceded the current one.

For example, authorization, a temporary transaction type, precedes and is completed by authorization.clearing, a final transaction type. In this case, the authorization token is returned with this field. For which transaction types are temporary or final, see Transaction events in Event Types.

preceding_transaction

Returned for authorization.clearing transaction types following a financial advice.

Contains information about the preceding transaction.

preceding_transaction.amount

Amount of the preceding transaction.

preceding_transaction.token

Unique identifier of the preceding transaction.

amount_to_be_released

Amount to release following a financial advice.

incremental_authorization_transaction_tokens

List of incremental authorization transaction tokens.

Valid incremental authorization transaction tokens

card_acceptor

Contains information about the merchant.

Valid card_acceptor object

card_acceptor.mcc

Merchant category code (MCC).

Valid MCC.

5 char max

card_acceptor.partial_approval_capable

Whether the response can approve an amount less than or equal to the requested amount.

true, false

Default value:
false

card_acceptor.name

Card acceptor’s name.

50 char max

card_acceptor.street_address

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

255 char max

card_acceptor.address

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

255 char max

card_acceptor.city

Card acceptor’s city.

40 char max

card_acceptor.state

Card acceptor’s state.

2 char max

card_acceptor.zip

Card acceptor’s zip or postal code.

10 char max

card_acceptor.country_code

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

card_acceptor.country

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

card_acceptor.payment_facilitator_id

The payment facilitator identifier of the card acceptor. This field is returned if it is provided by the card network.

For Mastercard, an 11-digit number. For Visa, a variable-length alphanumeric identifier, 11 char max.

card_acceptor.independent_sales_organization_id

The independent sales organization identifier of the card acceptor. This field is returned if it is provided by the card network.

For Mastercard, an 11-digit number. For Visa, an 11-character alphanumeric identifier.

card_acceptor.sub_merchant_id

The sub-merchant identifier of the card acceptor. This field is returned if it is provided by the card network.

For Mastercard, a 15-character alphanumeric identifier. For Visa, a variable-length alphanumeric identifier, 15 char max.

from_account

Specifies the account type for ATM transactions.

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

multi_clearing_sequence_number

If an authorization has multiple clearing transactions, this field displays the sequence number for the clearing transaction. For example, if this is the second clearing transaction of four, the sequence number is 02.

The sequence number returned in the clearing record.

multi_clearing_sequence_count

If an authorization has multiple clearing transactions, this field displays their total number. For example, if an authorization has four clearing transactions, the sequence count is 04.

The sequence count returned in the clearing record.

gpa

Contains information about the GPA balances and pending credits.

A valid gpa object.

gpa.currency_code

Currency of the funds used in the transaction.

A valid three-digit ISO 4217 currency type.

gpa.ledger_balance

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.

Format: 0.00

gpa.available_balance

Ledger balance minus any authorized transactions that have not yet cleared. Also known as the card holder’s purchasing power. When using JIT Funding, this balance is usually equal to $0.00.

Format: 0.00

gpa.pending_credits

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

Format 0.00

gpa.impacted_amount

Balance change based on the amount of the transaction.

Format: 0.00

gpa.balances

Balances and related information for each currency used in the transaction.

A valid gpa.balances object.

gpa.balances.xxx

Balances and related information in the currency specified in the field name.

NOTE: In the field name, xxx represents the three-digit ISO 4217 currency type.

A valid gpa.balances.xxx object.

gpa.balances.usd.currency_code

Currency of balances and related information in this object.

A valid three-digit ISO 4217 currency type.

gpa.balances.usd.ledger_balance

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.

Format: 0.00

gpa.balances.usd.available_balance

Ledger balance minus any authorized transactions that have not yet cleared. Also known as the card holder’s purchasing power. If you are using JIT Funding, this balance is usually equal to $0.00.

Format: 0.00

gpa.balances.usd.pending_credits

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

Format: 0.00

gpa.balances.usd.impacted_amount

Amount to credit or debit from the GPA.

Format: 0.00

gpa_order

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

A valid gpa_order object.

gpa_order.token

Unique identifier of the funding transaction.

Format: UUID

gpa_order.amount

Amount of the funding transaction.

Format: 0.00

gpa_order.tags

Customer-defined tags describing the funding transaction.

99 char max

gpa_order.memo

Additional information describing the funding transaction.

225 char max

gpa_order.fees

List of fees associated with the funding transaction.

Existing fee_model objects.

gpa_order.created_time

Time when the funding transaction was last modified.

Format: yyyy-MM-ddTHH:mm:ssZ

gpa_order.last_modified_time

Time when the funding transaction was last modified.

Format: yyyy-MM-ddTHH:mm:ssZ

gpa_order.transaction_token

Unique identifier of the transaction being funded.

Format: UUID

gpa_order.state

Current status of the funding transaction.

gpa_order.response

Contains verification information about the funding transaction.

gpa_order.response.code

Assertion by the Marqeta platform, presented as a four-digit code, as to whether its verification data matches that provided by the cardholder.

One of the following assertion codes:

gpa_order.response.memo

Additional information about the GPA order response.

99 char max

gpa_order.funding

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

gpa_order.funding.amount

Amount of funds loaded into the GPA.

Format: 0.00

gpa_order.funding.source

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

gpa_order.funding.source.type

Funding type of the funding source.

ach, paymentcard

gpa_order.funding.source.token

Unique identifier of the funding source.

Format: UUID

gpa_order.funding.source.active

Whether the funding source is active.

true, false

Default value:
false

gpa_order.funding.source.is_default_account

Whether the funding source is the default account.

true, false

gpa_order.funding.source.created_time

Time when the funding source was created.

Format: yyyy-MM-ddTHH:mm:ssZ

gpa_order.funding.source.last_modified_time

Time when the funding source was last modified.

Format: yyyy-MM-ddTHH:mm:ssZ

gpa_order.funding.source_address

Contains information about the billing address of the funding source.

gpa_order.funding.source_address.user_token

OR

gpa_order.funding.source_address.business_token

Unique identifier of the account holder associated with the address.

Existing user or business token.

gpa_order.funding.source_address.token

Unique identifier of the address.

36 char max

Format: UUID

gpa_order.funding.source_address.first_name

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

40 char max

gpa_order.funding.source_address.last_name

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

40 char max

gpa_order.funding.source_address.address_1

Street address of the funding source.

225 char max

gpa_order.funding.source_address.address_2

Additional address information for the funding source.

225 char max

gpa_order.funding.source_address.city

City of the funding source.

40 char max

gpa_order.funding.source_address.state

State of the funding source.

2 char max

gpa_order.funding.source_address.zip

Zip code of the funding source.

10 char max

gpa_order.funding.source_address.postal_code

Postal code of the funding source.

10 char max

gpa_order.funding.source_address.country

Country of the funding source.

40 char max

gpa_order.funding.source_address.phone

Phone number of the funding source.

255 char max

gpa_order.funding.source_address.is_default_address

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

true, false

Default value:
false

gpa_order.funding.source_address.active

Whether the address is active.

true, false

Default value:
false

gpa_order.funding.source_address.created_time

Date and time when the address was created.

Format: yyyy-MM-ddTHH:mm:ssZ

gpa_order.funding.source_address.last_modified_time

Date and time when the address was last modified.

Format: yyyy-MM-ddTHH:mm:ssZ

gpa_order.funding.gateway_log

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

gpa_order.funding.gateway_log.order_number

Customer order number, same value as transaction.token.

Existing transaction.token value.

gpa_order.funding.gateway_log.transaction_id

Customer-defined identifier for the transaction.

gpa_order.funding.gateway_log.message

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.

Approved or completed successfully, Declined by gateway, Operation timeout

gpa_order.funding.gateway_log.duration

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

Format: int64

gpa_order.funding.gateway_log.timed_out

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

Default value:
false

gpa_order.funding.gateway_log.response

Contains information on the gateway’s response to a funding request.

Existing response object.

gpa_order.funding.gateway_log.response.code

Code received from the gateway.

gpa_order.funding.gateway_log.response.data

Any additional data sent by the gateway.

gpa_order.funding.gateway_log.response.data.jit_funding

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

gpa_order.funding.gateway_log.response.data.jit_funding.token

Unique identifier of the JIT Funding request and response.

Existing JIT Funding token matching the request.

36 char max

gpa_order.funding.gateway_log.response.data.jit_funding.method

JIT Funding response type.

Existing JIT Funding method matching the request.

36 char max

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

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

OR

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

Holder of the account to be funded.

Either a user_token or business_token field is present, not both.

Existing user or business token matching the request.

36 char max

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

User who conducted the transaction.

Can be a child user configured to share its parent’s account balance.

Existing user token matching the request.

36 char max

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

Requested amount of funding.

Format: 0.00

If partial_approval_capable is false, the response amount must match the request amount. If partial_approval_capable is true, the response amount must be equal to or less than the request amount and greater than zero.

NOTE: The JIT Funding request contains multiple amount fields. Ensure that you use the value from gpa_order.jit_funding.amount. Do not use the value from the top-level amount field or any other amount field because those fields might contain a value different from the gpa_order.jit_funding.amount field. In particular, amount fields will differ if the account being funded has a positive account balance before JIT Funding is requested. Associated fees can also cause amount field values to differ.

gpa_order.funding.gateway_log.response.data.jit_funding.memo

Additional information on the JIT Funding transaction.

Returned for authorization and authorization completion transactions.

99 char max

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

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.

Existing original JIT Funding token matching the request.

36 char max

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

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.

Existing incremental authorization JIT funding tokens.

gpa_order.funding.gateway_log.response.data.jit_funding.address_verification

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.

Existing gpa_order.funding.gateway_log.response.data.jit_funding.address_verification object.

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

Contains address verification data provided by the cardholder.

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

Street address provided by the cardholder.

40 char max

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

Postal code provided by the cardholder.

9 char max

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

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

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

Contains address verification data held by the Marqeta platform.

An existing gpa_order.jit_funding.address_verification.issuer.on_file object.

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

Street address provided by the Marqeta platform.

This field is a concatenation of the address1 and address2 fields associated with the cardholder.

40 char max

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

Zip code provided by the Marqeta platform.

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

Postal code provided by the Marqeta platform.

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

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

Existing gpa_order.jit_funding.address_verification.issuer.response object.

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

Assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder. The assertion is presented as a four-digit code.

One of the following assertion codes:

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

Additional information on the address verification.

Returned for authorization and authorization completion transactions.

99 char max

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

Contains gateway-held address verification data and the gateway’s assertion as to whether its data matches the data provided by the cardholder.

Returned when overriding the assertion provided in the JIT Funding request.

Existing gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway object.

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

Contains address verification data held by the gateway.

Existing gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file object.

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

Street address provided by the gateway.

40 char max

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

Zip code provided by the gateway.

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

Postal code provided by the gateway.

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

Contains the gateway’s assertion as to whether its address verification data matches the cardholder’s.

Existing gpa_order.funding.gateway_log.response.data.jit_funding.address_verification.gateway.response object.

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

Gateway’s assertion as to whether the address verification data provided by the gateway and cardholder match. The assertion is presented as a four-digit code.

One of the following assertion codes:

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

Additional information on about the address verification.

Returned for authorization and authorization completion transactions.

99 char max

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

Contains the GPA’s balance details.

Existing gpa_order.funding.gateway_log.response.data.jit_funding.balances object.

gpa_order.funding.gateway_log.response.data.jit_funding.balances.currency_code

Currency of the funds used in the transaction.

A valid three-digit ISO 4217 currency type. For example, USD.

gpa_order.funding.gateway_log.response.data.jit_funding.balances.ledger_balance

Authorized funds that are currently on hold but not yet cleared.

Format: 0.00

gpa_order.funding.gateway_log.response.data.jit_funding.balances.available_balance

Ledger balance minus any authorized transactions that have not yet cleared. Also known as the card holder’s purchasing power. When using JIT Funding, this balance is usually equal to $0.00.

Format: 0.00

gpa_order.funding.gateway_log.response.data.jit_funding.balances.pending_credits

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

gpa_order.funding.gateway_log.response.data.jit_funding.balances.impacted_amount

Balance change based on the amount of the transaction.

gpa_order.funding_source_token

Unique identifier of the funding source.

Existing funding source token.

gpa_order.funding_source_address_token

Unique identifier of the funding source address.

Existing funding source address token.

gpa_order.jit_funding

Contains the information about the JIT Funding load event, where funds are loaded into an account.

An existing gpa_order.jit_funding object.

gpa_order.jit_funding.token

Unique identifier of the JIT Funding notification.

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.

36 char max

gpa_order.jit_funding.method

JIT Funding notification type.

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.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.reversal

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

gpa_order.jit_funding.user_token

OR

gpa_order.jit_funding.business_token

Holder of the account that was funded.

Either a user_token or business_token field is present, not both.

Existing user or business token value.

36 char max

gpa_order.jit_funding.acting_user_token

User who conducted the transaction.

Can be a child user configured to share its parent’s account balance.

Existing user token value.

36 char max

gpa_order.jit_funding.amount

Requested amount of funding.

NOTE: This field’s value can differ from the transaction’s top-level amount field or any other amount field within the transaction. In particular, these fields will differ if the account being funded already has a positive account balance. Associated fees can also cause these fields to differ.

Format: 0.00

gpa_order.jit_funding.memo

Additional information that describes the JIT funding transaction.

key-value pairs

99 char max

gpa_order.jit_funding.tags

Customer-defined tag for the JIT funding transaction.

255 char max

gpa_order.jit_funding.original_jit_funding_token

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.

Existing JIT Funding token value.

36 char max

gpa_order.jit_funding.incremental_authorization_jit_funding_tokens

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.

Existing incremental authorization JIT funding tokens.

gpa_order.jit_funding.address_verification

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.

Existing gpa_order.jit_funding.address_verification object.

gpa_order.jit_funding.address_verification.request

Contains address verification data provided by the cardholder.

Existing gpa_order.jit_funding.address_verification.request object.

gpa_order.jit_funding.address_verification.request.street_address

Street address provided by the cardholder.

40 char max

gpa_order.jit_funding.address_verification.request.zip

Postal code provided by the cardholder.

9 char max

gpa_order.jit_funding.address_verification.issuer

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

gpa_order.jit_funding.address_verification.issuer.on_file

Contains address verification data held by the Marqeta platform.

An existing gpa_order.jit_funding.address_verification.issuer.on_file object.

gpa_order.jit_funding.address_verification.issuer.on_file.street_address

Street address provided by the Marqeta platform.

This field is a concatenation of the address1 and address2 fields associated with the cardholder.

40 char max

gpa_order.jit_funding.address_verification.issuer.on_file.zip

Zip code provided by the Marqeta platform.

gpa_order.jit_funding.address_verification.issuer.on_file.postal_code

Postal code provided by the Marqeta platform.

gpa_order.jit_funding.address_verification.issuer.response

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

Existing gpa_order.jit_funding.address_verification.issuer.response object.

gpa_order.jit_funding.address_verification.issuer.response.code

Assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder. The assertion is presented as a four-digit code.

One of the following assertion codes:

gpa_order.jit_funding.address_verification.issuer.response.memo

Additional information on the address verification.

Returned for authorization and authorization completion transactions.

99 char max

gpa_order.jit_funding.address_verification.gateway

Contains gateway-held address verification data and the gateway’s assertion as to whether its data matches the data provided by the cardholder.

Returned when overriding the assertion provided in the JIT Funding request.

Existing gpa_order.jit_funding.address_verification.gateway.on_file object.

gpa_order.jit_funding.address_verification.gateway.on_file

Contains address verification data held by the gateway.

Existing gpa_order.jit_funding.address_verification.gateway.on_file object.

gpa_order.jit_funding.address_verification.gateway.on_file.street_address

Street address provided by the gateway.

40 char max

gpa_order.jit_funding.address_verification.gateway.on_file.zip

Zip code provided by the gateway.

gpa_order.jit_funding.address_verification.gateway.on_file.postal_code

Postal code provided by the gateway.

gpa_order.jit_funding.address_verification.gateway.response

Contains the gateway’s assertion as to whether its address verification data matches the cardholder’s.

Existing gpa_order.jit_funding.address_verification.gateway.response object.

gpa_order.jit_funding.address_verification.gateway.response.code

Gateway’s assertion as to whether the address verification data provided by the gateway and cardholder match. The assertion is presented as a four-digit code.

One of the following assertion codes:

gpa_order.jit_funding.address_verification.gateway.response.memo

Additional information on the address verification.

Returned for authorization and authorization completion transactions.

99 char max

gpa_order.jit_funding.balances

Contains the GPA’s balance details.

Existing gpa_order.jit_funding.balances object.

gpa_order.jit_funding.balances.currency_code

Currency of the funds used in the transaction.

A valid three-digit ISO 4217 currency type. For example, USD.

gpa_order.jit_funding.balances.ledger_balance

Authorized funds that are currently on hold but not yet cleared.

Format: 0.00

gpa_order.jit_funding.balances.available_balance

Ledger balance minus any authorized transactions that have not yet cleared. Also known as the card holder’s purchasing power. When using JIT Funding, this balance is usually equal to $0.00.

Format 0.00

gpa_order.jit_funding.balances.pending_credits

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

gpa_order.jit_funding.balances.impacted_amount

Balance change based on the amount of the transaction.

gpa_order.user_token

OR

gpa_order.business_token

Unique identifier of the account holder of the account being funded.

Existing user or business token.

Send a GET request to /users to retrieve user tokens or to /businesses to retrieve business tokens.

gpa_order.currency_code

Currency of the funding transaction.

3-character ISO 4217 currency code

card

Contains information about a specific card.

Existing card object.

card.created_time

Date and time when the card was created.

Format: yyyy-MM-ddTHH:mm:ssZ

card.last_modified_time

Date and time when the card was last modified.

Format: yyyy-MM-ddTHH:mm:ssZ

card.token

Unique identifier of the card.

36 char max

card.user_token

Unique identifier of the authorized user of the card.

Existing user token.

36 char max

card.card_product_token

Unique identifier of the card product.

Existing card product token.

36 char max

card.last_four

Last four digits of the card PAN.

card.pan

PAN of the card.

Existing card PAN.

card.cvv_number

Three-digit card verification value (CVV2) included on the back of the card.

3 char max

card.chip_cvv_number

Three-digit card verification value (CVV2) included on the back of the card.

card.barcode

Barcode of the card.

card.pin_is_set

Whether a PIN was set.

true, false

Default value:
false

card.state

State of the card.

ACTIVE, SUSPENDED, TERMINATED, UNSUPPORTED, UNACTIVATED

card.state_reason

Reason for the state of the card.

card.fulfillment

Status of the card fulfillment.

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

card.fulfillment.shipping

Contains information about the card fulfillment’s shipping address.

Existing fulfillment.shipping object.

card.fulfillment.shipping.method

Method of shipment.

card.fulfillment.shipping.return_address

Contains information about the card fulfillment’s return address, in case it could not be shipped.

card.fulfillment.shipping.return_address.first_name

First name.

40 char max

card.fulfillment.shipping.return_address.last_name

Last name.

40 char max

card.fulfillment.shipping.return_address.address_1

Street address

225 char max

card.fulfillment.shipping.return_address.address_2

Additional address information.

225 char max

card.fulfillment.shipping.return_address.city

City.

40 char max

card.fulfillment.shipping.return_address.state

State.

2 char max

card.fulfillment.shipping.return_address.zip

Zip code.

10 char max

card.fulfillment.shipping.return_address.postal_code

Postal code.

10 char max

card.fulfillment.shipping.return_address.country

Country.

40 char max

card.fulfillment.shipping.return_address.phone

Phone number.

20 char max

card.fulfillment.shipping.recipient_address

Contains information about the address of the recipient.

card.fulfillment.shipping.recipient_address.first_name

First name.

40 char max

card.fulfillment.shipping.recipient_address.last_name

Last name.

40 char max

card.fulfillment.shipping.recipient_address.address_1

Street address.

225 char max

card.fulfillment.shipping.recipient_address.address_2

Additional address information.

225 char max

card.fulfillment.shipping.recipient_address.city

City.

40 char max

card.fulfillment.shipping.recipient_address.state

State.

2 char max

card.fulfillment.shipping.recipient_address.zip

Zip code.

10 char max

card.fulfillment.shipping.recipient_address.postal_code

Postal code.

10 char max

card.fulfillment.shipping.recipient_address.country

Country.

40 char max

card.fulfillment.shipping.recipient_address.phone

Phone number.

20 char max

card.fulfillment.shipping.care_of_line

Name of person or company receiving the card on behalf of the recipient.

card.fulfillment.card_personalization

Contains information about personalized attributes added to the card.

Existing card_personalization object.

card.fulfillment.text

Contains personalized text that appears on the card.

Existing fulfillment.card_personalization.text object.

card.fulfillment.text.name_line_1.value

First line of personalized text printed on the face of the card.

Valid characters differ according to your fulfillment provider:

21 char max. Strings longer than 21 characters are truncated.

card.fulfillment.text.name_line_2.value

Second line of personalized text printed on the face of the card.

Valid characters differ according to your fulfillment provider:

21 char max. Strings longer than 21 characters are truncated.

card.fulfillment.text.name_line_3.value

Third line of personalized text printed on the face of the card.

Valid characters differ according to your fulfillment provider:

21 char max. Strings longer than 21 characters are truncated.

card.fulfillment.carrier

Contains attributes of the card carrier (if your fulfillment provider is Arroweye Solutions).

Existing fulfillment.card_personalization.carrier object.

card.fulfillment.carrier.template_id

Card carrier template to use.

A card carrier template ID.

card.fulfillment.carrier.logo_file

Image to display on the card carrier.

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

card.fulfillment.carrier.logo_thumbnail_file

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

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

card.fulfillment.carrier.message_file

Specifies a text file containing a custom message to print on the card carrier.

Contains the name of the text file. Must match the name of the file you send to your fulfillment provider.

card.fulfillment.carrier.message_line

Specifies a custom message that appears on the card carrier.

60 char max

card.fulfillment.images

Contains personalized images that appear on the card (for individual card orders only). Also specifies attributes of the card carrier, if your fulfillment provider is Perfect Plastic Printing or IDEMIA.

NOTE: The images object does not store or pass any actual image data. It only specifies image files that you send to your fulfillment provider.

Existing fulfillment.card_personalization.images object.

card.fulfillment.images.card

Specifies personalized images that appear on the card.

card.fulfillment.images.card.name

Specifies a PNG image to display on the card.

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

Must end in .png.

card.fulfillment.images.card.thermal_color

Specifies the color of the image displayed on the card.

Contains the name of the color. Must match one of the provider’s predefined colors.

card.fulfillment.images.signature.name

Specifies a PNG image of the cardholder’s signature.

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

Must end in .png.

card.fulfillment.images.carrier_return_window.name

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

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

Must end in .png.

card.fulfillment.perso_type

Specifies the method for printing personalized text on the card.

EMBOSS, LASER, FLAT

card.fulfillment.card_fulfillment_reason

Specifies the reason for card fulfillment.

NEW, LOST_STOLEN, EXPIRED

card.instrument_type

Instrument type of the card used in the transaction.

PHYSICAL_MSR, PHYSICAL_ICC, PHYSICAL_CONTACTLESS, PHYSICAL_COMBO, VIRTUAL_PAN

card.expedite

Whether to expedite the card.

true, false

Default value:
false

card.metadata

Custom metadata associated with the card used in the transaction.

Customer-defined strings as key/value pairs.

gpa_order_unload

Contains information about a GPA order unload, which unloads a GPA order by returning funds to the funding source.

gpa_order_unload.token

Unique identifier of the GPA order unload.

gpa_order_unload.amount

Amount of funds to return to funding source.

gpa_order_unload.created_time

Date and time when the GPA order unload was created.

gpa_order_unload.last_modified_time

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

gpa_order_unload.transaction_token

Unique identifier of the original funding transaction to unload.

Existing transaction token.

gpa_order_unload.state

Current status of the GPA order unload.

gpa_order_unload.response

Contains verification information for the GPA order unload.

gpa_order_unload.response.code

Four-digit code asserting whether its verification data matches that provided by the cardholder.

gpa_order_unload.response.memo

Additional comments about the outcome of the verification.

gpa_order_unload.funding

Contains funding information for the GPA order unload, including funding amount, type, and time.

gpa_order_unload.funding.amount

Amount of funds unloaded and returned to the funding source.

gpa_order_unload.funding.source

Contains funding source information for the GPA order unload, including funding type and time.

gpa_order_unload.funding.source.type

Funding type of the funding source.

gpa_order_unload.funding.source.token

Unique identifier of the funding source.

gpa_order_unload.funding.source.active

Whether the funding source is active.

true, false

gpa_order_unload.funding.source.name

Name of the funding source.

gpa_order_unload.funding.source.is_default_account

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

true, false

gpa_order_unload.funding.source.created_time

Date and time when the funding source was created.

gpa_order_unload.funding.source.last_modified_time

Date and time when the funding source was last modified.

gpa_order_unload.funding_source_token

Unique identifier of the funding source to which to return funds.

Existing funding source token.

gpa_order_unload.jit_funding

Contains information about the JIT Funding unload event, where funds are removed from an account.

Existing gpa_order_unload.jit_funding event.

gpa_order_unload.jit_funding.token

Unique identifier of the JIT Funding notification.

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.

36 char max

gpa_order_unload.jit_funding.method

JIT Funding notification type.

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.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.reversal

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

gpa_order_unload.jit_funding.user_token

OR

gpa_order_unload.jit_funding.business_token

Holder of the account that was funded.

Either a user_token or business_token field is present, not both.

Existing user or business token value.

36 char max

gpa_order_unload.jit_funding.acting_user_token

User who conducted the transaction.

Can be a child user configured to share its parent’s account balance.

Existing user token value.

36 char max

gpa_order_unload.jit_funding.amount

Requested amount of funding.

NOTE: This field’s value can differ from the transaction’s top-level amount field or any other amount field within the transaction. In particular, these fields will differ if the account being funded already has a positive account balance. Associated fees can also cause these fields to differ.

Format: 0.00

gpa_order_unload.jit_funding.memo

Additional information that describes the JIT funding transaction.

99 char max

gpa_order_unload.jit_funding.tags

Customer-defined tags for the JIT funding transaction.

255 char max

gpa_order_unload.jit_funding.original_jit_funding_token

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.

Existing JIT Funding token value.

36 char max

gpa_order_unload.jit_funding.incremental_authorization_jit_funding_tokens

List 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.

Existing JIT funding tokens.

gpa_order_unload.jit_funding.address_verification

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.

Existing gpa_order_unload.jit_funding.address_verification object.

gpa_order_unload.jit_funding.address_verification.request

Contains address verification data provided by the cardholder.

Existing gpa_order_unload.jit_funding.address_verification.request object.

gpa_order_unload.jit_funding.address_verification.request.street_address

Street address provided by the cardholder.

40 char max

gpa_order_unload.jit_funding.address_verification.request.zip

Postal code provided by the cardholder.

9 char max

gpa_order_unload.jit_funding.address_verification.issuer

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

gpa_order_unload.jit_funding.address_verification.issuer.on_file

Contains address verification data held by the Marqeta platform.

An existing gpa_order_unload.jit_funding.address_verification.issuer.on_file object.

gpa_order_unload.jit_funding.address_verification.issuer.on_file.street_address

Street address provided by the Marqeta platform.

This field is a concatenation of the address1 and address2 fields associated with the cardholder.

40 char max

gpa_order_unload.jit_funding.address_verification.issuer.on_file.zip

Zip code provided by the Marqeta platform.

gpa_order_unload.jit_funding.address_verification.issuer.on_file.postal_code

Postal code provided by the Marqeta platform.

gpa_order_unload.jit_funding.address_verification.issuer.response

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

Existing gpa_order_unload.jit_funding.address_verification.issuer.response object.

gpa_order_unload.jit_funding.address_verification.issuer.response.code

Assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder. The assertion is presented as a four-digit code.

One of the following assertion codes:

gpa_order_unload.jit_funding.address_verification.issuer.response.memo

Additional information on the address verification.

Returned for authorization and authorization completion transactions.

99 char max

gpa_order_unload.jit_funding.address_verification.gateway

Contains gateway-held address verification data and the gateway’s assertion as to whether its data matches the data provided by the cardholder.

Returned when overriding the assertion provided in the JIT Funding request.

Existing gpa_order_unload.jit_funding.address_verification.gateway.on_file object.

gpa_order_unload.jit_funding.address_verification.gateway.on_file

Contains address verification data held by the gateway.

Existing gpa_order_unload.jit_funding.address_verification.gateway.on_file object.

gpa_order_unload.jit_funding.address_verification.gateway.on_file.street_address

Street address provided by the gateway.

40 char max

gpa_order_unload.jit_funding.address_verification.gateway.on_file.zip

Zip code provided by the gateway.

gpa_order_unload.jit_funding.address_verification.gateway.on_file.postal_code

Postal code provided by the gateway.

gpa_order_unload.jit_funding.address_verification.gateway.response

Contains the gateway’s assertion as to whether its address verification data matches the cardholder’s.

Existing gpa_order_unload.jit_funding.address_verification.gateway.response object.

gpa_order_unload.jit_funding.address_verification.gateway.response.code

Gateway’s assertion as to whether the address verification data provided by the gateway and cardholder match. The assertion is presented as a four-digit code.

One of the following assertion codes:

gpa_order_unload.jit_funding.address_verification.gateway.response.memo

Additional information on the address verification.

Returned for authorization and authorization completion transactions.

99 char max

gpa_order_unload.jit_funding.balances

Contains the GPA’s balance details.

Existing gpa_order.jit_funding.balances object.

gpa_order_unload.jit_funding.balances.currency_code

Currency of the funds used in the transaction.

A valid three-digit ISO 4217 currency type. For example, USD.

gpa_order_unload.jit_funding.balances.ledger_balance

Authorized funds that are currently on hold but not yet cleared.

Format: 0.00

gpa_order_unload.jit_funding.balances.available_balance

Ledger balance minus any authorized transactions that have not yet cleared. Also known as the card holder’s purchasing power. When using JIT Funding, this balance is usually equal to $0.00.

gpa_order_unload.jit_funding.balances.pending_credits

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

gpa_order_unload.jit_funding.balances.impacted_amount

Balance change based on the amount of the transaction.

program_transfer

Contains information about a program transfer, which moves funds from an account holder’s GPA to a program funding source.

program_transfer.fees

List of fees to add to the program transfer and debit from the account holder’s GPA.

Valid fees.

program_transfer.token

Unique identifier of the program transfer.

36 char max

program_transfer.user_token

Required if business_token is null.

36 char max

program_transfer.business_token

Required if user_token is null.

36 char max

program_transfer.amount

Amount to be transferred.

Format: 0.00

program_transfer.type_token

Unique identifier of the program transfer type.

Existing program transfer type token.

program_transfer.tags