> ## Documentation Index > Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Transactions > Transactions are electronic messages that carry information used for payment processing. Retrieve transaction data associated with specific cards and account holders. export const EndpointCard = ({method = "API", title, children, href, arrow = true}) => { const METHOD_STYLES = { GET: { bg: "mint-bg-green-400/20 dark:mint-bg-green-400/20", text: "mint-text-green-700 dark:mint-text-green-400", border: "mint-border-green-300 dark:mint-border-green-700" }, POST: { bg: "mint-bg-blue-400/20 dark:mint-bg-blue-400/20", text: "mint-text-blue-700 dark:mint-text-blue-400" }, PUT: { bg: "mint-bg-yellow-400/20 dark:mint-bg-yellow-400/20", text: "mint-text-yellow-700 dark:mint-text-yellow-400" }, PATCH: { bg: "mint-bg-orange-400/20 dark:mint-bg-orange-400/20", text: "mint-text-orange-700 dark:mint-text-orange-400" }, DELETE: { bg: "mint-bg-red-400/20 dark:mint-bg-red-400/20", text: "mint-text-red-700 dark:mint-text-red-400" }, API: { bg: "mint-bg-black", text: "mint-text-white" } }; const MethodBadge = ({method}) => { const style = METHOD_STYLES[method?.toUpperCase()] ?? METHOD_STYLES.GET; return {method?.toUpperCase()} ; }; const content =
{}
{}

{title}

{children &&

{children}

}
; if (!href) return content; return {content} ; }; 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](/developer-guides/about-webhooks/) guide. See the transaction events for which you can set up webhooks in the [Event Types](/core-api/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](/developer-guides/about-transactions/#_transaction_response_codes), see [About Transactions](/developer-guides/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](/diva-api/introduction/).

Transaction object

Transactions are represented by the `transaction` object. The Marqeta platform creates a separate `transaction` object for each transaction message received from the card network. The attributes of a given `transaction` object depend on the transaction type. This section documents all fields that might be included in a `transaction` object. | Fields | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | account\_funding

object

Optional | Contains details about account funding transactions. Account funding transactions move money into a cardholder’s general purpose account (GPA).

**Allowable Values:**

funding\_source, receiver\_account\_type, receiver\_name, screening\_score, transaction\_purpose, transaction\_type | | account\_funding.**funding\_source**

string

Optional | Specifies the type of account from which the transaction was funded.

**Allowable Values:**

CREDIT, DEBIT, PREPAID, DEPOSIT\_ACCOUNT, CASH, MOBILE\_MONEY\_ACCOUNT, NON\_VISA\_CREDIT, CHECK, ACH | | account\_funding.**receiver\_account\_type**

string

Optional | Specifies the type of account receiving the funding.

**Allowable Values:**

OTHER, RTN\_BANK\_ACCOUNT, IBAN, CARD\_ACCOUNT, EMAIL, PHONE\_NUMBER, BANK\_ACCOUNT\_NUMBER\_AND\_BANK\_IDENTIFICATION\_CODE, WALLET\_ID, SOCIAL\_NETWORK\_ID | | account\_funding.**receiver\_name**

string

Optional | Specifies the name of the account holder receiving the funding.

**Allowable Values:**

255 char max | | account\_funding.**screening\_score**

string

Optional | Sanctions screening score to assist with meeting Anti-Money Laundering (AML) obligations.

Higher scores indicate that the sender’s data more closely resembles an entry on the regulatory watchlist.

A value of 999 means no score was available.

**Allowable Values:**

000-100 or 999 | | account\_funding.**sender\_account\_number**

string

Optional | Account number of the sender funding the transaction.

**Allowable Values:**

255 char max | | account\_funding.**sender\_address**

string

Optional | Street address of the sender funding the transaction.

**Allowable Values:**

255 char max | | account\_funding.**sender\_city**

string

Optional | City of the sender funding the transaction.

**Allowable Values:**

255 char max | | account\_funding.**sender\_country**

string

Optional | Country of the sender funding the transaction.

**Allowable Values:**

255 char max | | account\_funding.**sender\_name**

string

Optional | Name of the sender funding the transaction.

**Allowable Values:**

255 char max | | account\_funding.**sender\_state**

string

Optional | State or province of the sender funding the transaction.

**Allowable Values:**

255 char max | | account\_funding.**transaction\_purpose**

string

Optional | Describes the purpose of the account funding transaction.

**Allowable Values:**

boleto\_payment, crypto\_currency, education, emergency\_need, family\_support, gifts, labor\_transfers, lending, medical\_treatment, other, recycling\_deposit\_return, refund\_to\_new\_card, refund\_to\_original\_card, salary, savings, transfer\_to\_another\_person\_or\_organization\_in\_the\_same\_staged\_digital\_wallet, travel, value\_added\_tax\_payment | | account\_funding.**transaction\_type**

string

Optional | Specifies the account funding transaction type.

**Allowable Values:**

ACCOUNT\_TO\_ACCOUNT, PERSON\_TO\_PERSON, WALLET\_TRANSFER, MONEY\_TRANSFER\_BY\_BANK, BUSINESS\_TO\_BUSINESS, DISBURSEMENT, GOVERNMENT\_DISBURSEMENT, GAMBLING\_PAYOUT, LOYALTY, MERCHANT\_DISBURSEMENT, ONLINE\_GAMBLING\_PAYOUT, PENSION\_DISBURSEMENT, PREPAID\_LOADS, CARD\_BILL\_PAYMENT, BILL\_PAYMENT, CASH\_CLAIM, CASH\_IN, CASH\_OUT, MOBILE\_AIR\_TIME\_PAYMENT, MONEY\_TRANSFER\_BY\_MERCHANT, FACE\_TO\_FACE\_MERCHANT\_PAYMENT, GOVERNMENT\_PAYMENT, PAYMENTS\_GOODS\_SERVICES, FUNDS\_TRANSFER, GENERAL\_BUSINESS\_TO\_BUSINESS\_TRANSFER, BUSINESS\_TO\_BUSINESS\_TRANSFER, CASH\_DEPOSIT, PURCHASE\_REPAYMENT, AFT\_OR\_OCT\_ELIGIBILITY, CONSUMER\_BILL\_PAYMENT, REQUEST\_TO\_PAY, LIQUID\_ASSET, FAST\_REFUND | | account\_owner

object

Optional | Information about the owner of an account participating in an account funding or original credit transaction.

**Allowable Values:**

country\_of\_birth, dob, email\_address, nationality, occupation | | account\_owner.**country\_of\_birth**

string

Optional | Account owner’s country of birth.

**Allowable Values:**

255 char max | | account\_owner.**dob**

string

Optional | Account owner’s date of birth.

**Allowable Values:**

255 char max | | account\_owner.**email\_address**

string

Optional | Account owner’s email address.

**Allowable Values:**

255 char max | | account\_owner.**nationality**

string

Optional | Account owner’s nationality.

**Allowable Values:**

255 char max | | account\_owner.**occupation**

string

Optional | Account owner’s occupation.

**Allowable Values:**

255 char max | | acquirer

object

Optional | Contains information about the merchant’s financial institution.

**Allowable Values:**

Existing acquirer object | | acquirer.**city**

string

Optional | City of the merchant’s financial institution. This field appears only in account funding and original credit transactions.

**Allowable Values:**

255 char max | | acquirer.**country\_code**

string

Optional | Country code of the merchant’s financial institution. This field appears only in account funding and original credit transactions.

**Allowable Values:**

Valid three-digit ISO 3166 country code | | acquirer.**institution\_country**

string

Optional | Country code of the merchant’s financial institution.

**Allowable Values:**

Valid three-digit ISO 3166 country code | | acquirer.**institution\_id\_code**

string

Optional | Identifier code of the merchant’s financial institution.

**Allowable Values:**

255 char max | | acquirer.**merchant\_street\_address**

string

Optional | Street address of the merchant. This field appears only in account funding and original credit transactions.

**Allowable Values:**

255 char max | | acquirer.**name**

string

Optional | Name of the merchant’s financial institution. This field appears only in account funding and original credit transactions.

**Allowable Values:**

255 char max | | acquirer.**network\_international\_id**

string

Optional | International network identifier.

**Allowable Values:**

255 char max | | acquirer.**postal\_code**

string

Optional | Postal code of the merchant’s financial institution. This field appears only in account funding and original credit transactions.

**Allowable Values:**

255 char max | | acquirer.**state**

string

Optional | State where the merchant’s financial institution is located. This field appears only in account funding and original credit transactions.

**Allowable Values:**

255 char max | | acquirer.**retrieval\_reference\_number**

string

Optional | Retrieval reference number of the merchant’s financial institution.

**Allowable Values:**

255 char max | | acquirer.**system\_trace\_audit\_number**

string

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

**Allowable Values:**

255 char max | | acquirer\_fee\_amount

decimal

Optional | Indicates the amount of the acquirer fee. Account holders are sometimes charged an acquirer fee for card use at ATMs, fuel dispensers, and so on.

**Allowable Values:**

decimal

**Format:**
0.00 | | acquirer\_reference\_data

string

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

**Allowable Values:**

255 char max | | acquirer\_reference\_id

string

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

**Allowable Values:**

255 char max | | acting\_user\_token

string

Optional | Unique identifier of the user who conducted the transaction. This might be a child user configured to share its parent’s account balance.

**Allowable Values:**

36 char max | | address\_verification

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, request, response | | address\_verification.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | address\_verification.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | address\_verification.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | address\_verification.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | address\_verification.**request**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | address\_verification.request.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | address\_verification.request.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | address\_verification.request.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | address\_verification.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | address\_verification.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | address\_verification.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | address\_verification.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | account\_name\_verification

object

Optional | Contains name verification data: the full name entered by the cardholder, name data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, request, response | | account\_name\_verification.**on\_file**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | account\_name\_verification.on\_file.**first\_name**

string

Optional | First or given name of the cardholder.

**Allowable Values:**

255 char max | | account\_name\_verification.on\_file.**last\_name**

string

Optional | Last or family name of the cardholder.

**Allowable Values:**

255 char max | | account\_name\_verification.on\_file.**middle\_name**

string

Optional | Middle name of the cardholder.

**Allowable Values:**

255 char max | | account\_name\_verification.**request**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | account\_name\_verification.request.**first\_name**

string

Optional | First or given name of the cardholder.

**Allowable Values:**

255 char max | | account\_name\_verification.request.**last\_name**

string

Optional | Last or family name of the cardholder.

**Allowable Values:**

255 char max | | account\_name\_verification.request.**middle\_name**

string

Optional | Middle name of the cardholder.

**Allowable Values:**

255 char max | | account\_name\_verification.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | account\_name\_verification.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | account\_name\_verification.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | account\_name\_verification.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | advice\_reason\_code

string

Optional | Extended stand-in processing (STIP) reason code, as provided by the card network.

**Allowable Values:**

Reason code, as provided by the card network | | advice\_reason\_details

string

Optional | Extended stand-in processing (STIP) reason details, as provided by the card network.

**Allowable Values:**

Reason details, as provided by the card network | | amount

decimal

Required | Amount of the transaction.

**Allowable Values:**

decimal

**Format:**
0.00 | | amount\_to\_be\_released

decimal

Optional | Amount of original authorization to be released. This field appears in final clearing transactions where the clearing amount is lower than the authorization amount.

**Allowable Values:**

decimal

**Format:**
0.00 | | anticipated\_amount

decimal

Optional | Anticipated amount of the transaction, as provided by the card network. This field applies to anticipated amount verification transactions (AAVTs).

**Allowable Values:**

decimal

**Format:**
0.00 | | approval\_code

string

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

**Allowable Values:**

255 char max | | auto\_reload

object

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

Returned if an auto reload was executed.

**Allowable Values:**

active, association, currency\_code, funding\_source\_address\_token, funding\_source\_token, order\_scope, token | | auto\_reload.**active**

boolean

Optional | Specifies whether the auto reload is active.

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

**Allowable Values:**

true, false

**Default value:**
true | | auto\_reload.**association**

object

Optional | Specifies the scope of the auto reload.

Input no more than one field. If no value is supplied, the auto reload applies at the program level.

**Allowable Values:**

business\_token, card\_product\_token, user\_token | | auto\_reload.association.**business\_token**

string

Optional | Unique identifier of the business for which the auto reload is configured.

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

**Allowable Values:**

1–36 chars | | auto\_reload.association.**card\_product\_token**

string

Optional | Unique identifier of the card product for which the auto reload is configured.

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

**Allowable Values:**

1–36 chars | | auto\_reload.association.**user\_token**

string

Optional | Unique identifier of the user for which the auto reload is configured.

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

**Allowable Values:**

1–36 chars | | auto\_reload.**currency\_code**

string

Required | Three-digit ISO 4217 currency code.

**Allowable Values:**

Any currency code allowed by your program | | auto\_reload.**funding\_source\_address\_token**

string

Optional | Unique identifier of the funding source address to use for this auto reload.

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

Send a GET request to /fundingsources/addresses/user/{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 | | auto\_reload.**funding\_source\_token**

string

Optional | Unique identifier of the funding source to use for this auto reload.

Send a GET request to /fundingsources/user/{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 | | auto\_reload.**order\_scope**

object

Required | Defines the balance threshold and reload amounts.

**Allowable Values:**

gpa | | auto\_reload.order\_scope.**gpa**

object

Optional | Defines the type of order.

**Allowable Values:**

reload\_amount, trigger\_amount | | auto\_reload.order\_scope.gpa.**reload\_amount**

decimal

Required | Available balance on the card after the reload has completed.

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

**Allowable Values:**

0.01 min | | auto\_reload.order\_scope.gpa.**trigger\_amount**

decimal

Required | Threshold that determines when the reload happens.

The reload is triggered when the card balance falls below this amount.

**Allowable Values:**

0.01 min | | auto\_reload.**token**

string

Optional | Unique identifier of the auto reload.

If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.

**Allowable Values:**

1–36 chars | | batch\_number

string

Optional | The batch number of the transaction.

**Allowable Values:**

255 char max | | business

object

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

**Allowable Values:**

Existing business metadata | | business.**metadata**

object

Optional | Associates customer-provided metadata with the business.

**Allowable Values:**

Up to 20 name-value pair fields in "field\_name\_1": "field\_value\_1" format. | | business\_token

string

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

**Allowable Values:**

36 char max | | card

object

Optional | Contains information about the card used in the transaction.

**Allowable Values:**

activation\_actions, barcode, bulk\_issuance\_token, card\_product\_token, chip\_cvv\_number, contactless\_exemption\_counter,contactless\_exemption\_total\_amount, contactless\_exemption\_transaction\_currency, created\_time, cvv\_number, expidite, expiration, expiration\_time, fulfillment, fulfillment\_status, instrument\_type, last\_four, last\_modified\_time, metadata, pan, pin\_is\_set, reissue\_pan\_from\_card\_token, new\_pan\_from\_card\_token, state, state\_reason, token, translate\_pin\_from\_card\_token, user\_token | | card.**activation\_actions**

object

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

**Allowable Values:**

swap\_digital\_wallet\_tokens\_from\_card\_token, terminate\_reissued\_source\_card | | card.activation\_actions.**swap\_digital\_wallet\_tokens\_from\_card\_token**

string

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

Not relevant when reissue\_pan\_from\_card\_token is set.

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

**Allowable Values:**

1–36 chars

Existing card token | | card.activation\_actions.**terminate\_reissued\_source\_card**

boolean

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

Only relevant when reissue\_pan\_from\_card\_token is set.

**Allowable Values:**

true, false

**Default value:**
true | | card.**barcode**

string

Required | Barcode printed on the card, expressed as numerals.

**Allowable Values:**

10-20 chars | | card.**bulk\_issuance\_token**

string

Optional | Unique identifier of the bulk card order.

**Allowable Values:**

1-36 chars | | card.**card\_product\_token**

string

Required | Unique identifier of the card product.

**Allowable Values:**

1-36 chars | | card.**chip\_cvv\_number**

string

Optional | Three-digit card verification value (ICVV) stored on the chip of the card.

**Allowable Values:**

3 chars | | card.**contactless\_exemption\_counter**

integer

Optional | Running count of the contactless transactions successfully completed since the last strong customer authentication (SCA) challenge was issued. You can limit the number of contactless transactions that can be performed without issuing an SCA challenge at the card product level.

For more information about strong customer authentication, see Card Products.

**Allowable Values:**

Any integer | | card.**contactless\_exemption\_total\_amount**

decimal

Optional | Running total of the money spent in contactless transactions successfully completed since the last strong customer authentication (SCA) challenge was issued. You can limit the total amount that can be spent in contactless transactions without issuing an SCA challenge at the card product level.

For more information about strong customer authentication, see Card Products.

**Allowable Values:**

Any integer | | card.**contactless\_exemption\_transaction\_currency**

string

Optional | Indicates the currency type of the transaction.

**Allowable Values:**

Valid three-character ISO 4217 currency code | | card.**created\_time**

datetime

Required | Date and time when the resource was created, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | card.**cvv\_number**

string

Optional | Three-digit card verification value (CVV2 or CVC2) printed on the card.

**Allowable Values:**

3 chars | | card.**expedite**

boolean

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

**Allowable Values:**

true, false | | card.**expiration**

string

Required | Expiration date in MMyy format.

**Allowable Values:**

Format: MMyy | | card.**expiration\_time**

datetime

Required | Expiration date and time, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | card.**fulfillment**

object

Optional | Determines physical characteristics of a card and shipment information.

**Allowable Values:**

card\_fulfillment\_reason, card\_personalization, shipping | | card.fulfillment.**card\_fulfillment\_reason**

string

Optional | Descriptive reason for the card fulfillment.

**Allowable Values:**

NEW, LOST\_STOLEN, EXPIRED | | card.fulfillment.**card\_personalization**

object

Required | Specifies personalized attributes to be added to the card.

**Allowable Values:**

carrier, images, perso\_type, text | | card.fulfillment.card\_personalization.**carrier**

object

Optional | Specifies attributes of the card carrier.

**Allowable Values:**

logo\_file, logo\_thumbnail\_file, message\_file, message\_line, template\_id | | card.fulfillment.card\_personalization.carrier.**logo\_file**

string

Optional | Specifies an image to display on the card carrier.

**Allowable Values:**

Contains the name of the image file and must match the name of the file you send to your fulfillment provider. | | card.fulfillment.card\_personalization.carrier.**logo\_thumbnail\_file**

string

Optional | Specifies a thumbnail-sized rendering of the image specified in the logo\_file field.

**Allowable Values:**

Contains the name of the image file and must match the name of the file you send to your fulfillment provider. | | card.fulfillment.card\_personalization.carrier.**message\_file**

string

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

**Allowable Values:**

Contains the name of the text file and must match the name of the file you send to your fulfillment provider. | | card.fulfillment.card\_personalization.carrier.**message\_line**

string

Optional | Specifies a custom message that appears on the card carrier.

**Allowable Values:**

60 char max | | card.fulfillment.card\_personalization.carrier.**message\_line\_2**

string

Optional | Specifies the second line of a custom message that appears on the card carrier.

**Allowable Values:**

60 char max | | card.fulfillment.card\_personalization.carrier.**template\_id**

string

Optional | Specifies the card carrier template to use.

**Allowable Values:**

Card carrier template ID | | card.fulfillment.card\_personalization.**images**

object

Optional | Specifies personalized images that appear on the card.

**Allowable Values:**

card, carrier, carrier\_return\_window, signature | | card.fulfillment.card\_personalization.images.**card**

object

Optional | Specifies personalized images that appear on the card.

**Allowable Values:**

name, thermal\_color | | card.fulfillment.card\_personalization.images.card.**name**

string

Optional | Specifies a PNG image to display on the card.

**Allowable Values:**

Contains the name of the image file and must match the name of the file you send to your fulfillment provider. | | card.fulfillment.card\_personalization.images.card.**thermal\_color**

string

Optional | Specifies the color of the image displayed on the card.

**Allowable Values:**

Contains the name of the color and must match one of the provider’s predefined colors. | | card.fulfillment.card\_personalization.images.**carrier**

object

Optional | Specifies personalized images that appear on the card carrier.

**Allowable Values:**

message\_1, name | | card.fulfillment.card\_personalization.images.carrier.**message\_1**

string

Optional | Specifies a custom message that appears on the card carrier.

**Allowable Values:**

60 char max | | card.fulfillment.card\_personalization.images.carrier.**name**

string

Optional | Specifies a PNG image to display on the card carrier.

**Allowable Values:**

Contains the name of the image file and must match the name of the file you send to your fulfillment provider. | | card.fulfillment.card\_personalization.images.**carrier\_return\_window**

object

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

**Allowable Values:**

name | | card.fulfillment.card\_personalization.images.carrier\_return\_window.**name**

string

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

**Allowable Values:**

Contains the name of the image file and must match the name of the file you send to your fulfillment provider. | | card.fulfillment.card\_personalization.images.**signature**

object

Optional | Specifies a PNG image of the cardholder’s signature.

**Allowable Values:**

name | | card.fulfillment.card\_personalization.images.signature.**name**

string

Optional | Specifies a PNG image of the cardholder’s signature.

**Allowable Values:**

Contains the name of the image file and must match the name of the file you send to your fulfillment provider. | | card.fulfillment.card\_personalization.**perso\_type**

string

Optional | Specifies the type of card personalization.

**Allowable Values:**

EMBOSS, LASER, FLAT | | card.fulfillment.card\_personalization.**text**

object

Required | Specifies personalized text that appears on the card.

**Allowable Values:**

name\_line\_1, name\_line\_2, name\_line\_3 | | card.fulfillment.card\_personalization.text.**name\_line\_1**

object

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

**Allowable Values:**

name\_line\_1.value

21 char max; if name\_line\_1\_numeric\_postfix is true, 14 char max.

Strings longer than the character limit are truncated. | | card.fulfillment.card\_personalization.text.name\_line\_1.**value**

string

Optional | Line of personalized text printed on the card.

**Allowable Values:**

21 char max | | card.fulfillment.card\_personalization.text.**name\_line\_2**

object

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

**Allowable Values:**

name\_line\_2.value | | card.fulfillment.card\_personalization.text.name\_line\_2.**value**

string

Optional | Line of personalized text printed on the card.

**Allowable Values:**

21 char max | | card.fulfillment.card\_personalization.text.**name\_line\_3**

object

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

**Allowable Values:**

name\_line\_3.value | | card.fulfillment.card\_personalization.text.name\_line\_3.**value**

string

Optional | Line of personalized text printed on the card.

**Allowable Values:**

21 char max | | card.fulfillment.**shipping**

object

Optional | Specifies shipping details for the order.

This object is returned if it exists in the resource.

**Allowable Values:**

care\_of\_line, method, recipient\_address, return\_address | | card.fulfillment.shipping.**care\_of\_line**

string

Optional | Specifies the value of the care of (C/O) line on the mailing carrier.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max | | card.fulfillment.shipping.**method**

string

Optional | Specifies the shipping service.

This field is returned if it exists in the resource.

**Allowable Values:**

LOCAL\_MAIL, LOCAL\_MAIL\_PACKAGE, GROUND, TWO\_DAY, OVERNIGHT, INTERNATIONAL, INTERNATIONAL\_PRIORITY, LOCAL\_PRIORITY, FEDEX\_EXPEDITED, FEDEX\_REGULAR, UPS\_EXPEDITED, UPS\_REGULAR, USPS\_EXPEDITED, USPS\_REGULAR | | card.fulfillment.shipping.**recipient\_address**

object

Optional | Address to which the order will be shipped.

This field is returned if it exists in the resource.

**Allowable Values:**

Existing recipient\_address object | | card.fulfillment.shipping.recipient\_address.**address1**

string

Optional | Number and street of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max

Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. | | card.fulfillment.shipping.recipient\_address.**address2**

string

Optional | Additional address information.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max

Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. | | card.fulfillment.shipping.recipient\_address.**city**

string

Optional | City of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

40 char max | | card.fulfillment.shipping.recipient\_address.**country**

string

Optional | Country of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

40 char max

English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. | | card.fulfillment.shipping.recipient\_address.**first\_name**

string

Optional | First name of the addressee.

This field is returned if it exists in the resource.

**Allowable Values:**

40 char max | | card.fulfillment.shipping.recipient\_address.**last\_name**

string

Optional | Last name of the addressee.

This field is returned if it exists in the resource.

**Allowable Values:**

40 char max | | card.fulfillment.shipping.recipient\_address.**middle\_name**

string

Optional | Middle name of the addressee.

This field is returned if it exists in the resource.

**Allowable Values:**

40 char max | | card.fulfillment.shipping.recipient\_address.**phone**

string

Optional | Telephone number of the addressee.

This field is returned if it exists in the resource.

**Allowable Values:**

20 char max | | card.fulfillment.shipping.recipient\_address.**postal\_code**

string

Optional | Postal code of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

10 char max | | card.fulfillment.shipping.recipient\_address.**state**

string

Optional | State or province of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

32 char max | | card.fulfillment.shipping.recipient\_address.**zip**

string

Optional | United States ZIP code of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

10 char max | | card.fulfillment.shipping.**return\_address**

object

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

This object is returned if it exists in the resource.

**Allowable Values:**

Existing return\_address object | | card.fulfillment.shipping.return\_address.**address1**

string

Optional | Number and street of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max

Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. | | card.fulfillment.shipping.return\_address.**address2**

string

Optional | Additional address information.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max

Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters. | | card.fulfillment.shipping.return\_address.**city**

string

Optional | City of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

40 char max | | card.fulfillment.shipping.return\_address.**country**

string

Optional | Country of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

40 char max

English short name. For example, for the Kingdom of Spain, use the English short name "Spain". The ISO maintains the full list of country codes. | | card.fulfillment.shipping.return\_address.**first\_name**

string

Optional | First name of the addressee.

This field is returned if it exists in the resource.

**Allowable Values:**

40 char max | | card.fulfillment.shipping.return\_address.**last\_name**

string

Optional | Last name of the addressee.

This field is returned if it exists in the resource.

**Allowable Values:**

40 char max | | card.fulfillment.shipping.return\_address.**middle\_name**

string

Optional | Middle name of the addressee.

This field is returned if it exists in the resource.

**Allowable Values:**

40 char max | | card.fulfillment.shipping.return\_address.**phone**

string

Optional | Telephone number of the addressee.

This field is returned if it exists in the resource.

**Allowable Values:**

20 char max | | card.fulfillment.shipping.return\_address.**postal\_code**

string

Optional | Postal code of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

10 char max | | card.fulfillment.shipping.return\_address.**state**

string

Optional | State or province of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

32 char max | | card.fulfillment.shipping.return\_address.**zip**

string

Optional | United States ZIP code of the address.

This field is returned if it exists in the resource.

**Allowable Values:**

10 char max | | card.**fulfillment\_status**

string

Required | Card fulfillment status:

- **ISSUED:** Initial state of all newly created/issued cards.
- **ORDERED:** Card ordered through the card fulfillment provider.
- **REORDERED:** Card reordered through the card fulfillment provider.
- **REJECTED:** Card rejected by the card fulfillment provider.
- **SHIPPED:** Card shipped by the card fulfillment provider.
- **DELIVERED:** Card delivered by the card fulfillment provider.
- **DIGITALLY\_PRESENTED:** Card digitally presented using the /cards/{token}/showpan endpoint; does not affect the delivery of physical cards.

**Allowable Values:**

ISSUED, ORDERED, REORDERED, REJECTED, SHIPPED, DELIVERED, DIGITALLY\_PRESENTED | | card.**instrument\_type**

string

Optional | Instrument type of the card:

- **PHYSICAL\_MSR:** A physical card with a magnetic stripe. This is the default physical card type.
- **PHYSICAL\_ICC:** A physical card with an integrated circuit, or "chip."
- **PHYSICAL\_CONTACTLESS:** A physical card that uses radio frequency identification (RFID) or near-field communication (NFC) to enable payment over a secure radio interface.
- **PHYSICAL\_COMBO:** A physical card with a chip that also supports contactless payments.
- **VIRTUAL\_PAN:** A virtual card with a primary account number (PAN).

**Allowable Values:**

PHYSICAL\_MSR, PHYSICAL\_ICC, PHYSICAL\_CONTACTLESS, PHYSICAL\_COMBO, VIRTUAL\_PAN | | card.**last\_four**

string

Required | Last four digits of the card primary account number (PAN).

**Allowable Values:**

4 chars | | card.**last\_modified\_time**

datetime

Required | Date and time when the resource was last modified, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | card.**metadata**

object

Optional | Associates customer-provided metadata with the card.

**Allowable Values:**

Contains the names and values of up to 20 fields in the format "my\_name\_1": "my\_value\_1" | | card.**pan**

string

Required | Primary account number (PAN) of the card.

**Allowable Values:**

16 char max | | card.**pin\_is\_set**

boolean

Required | Specifies if the personal identification number (PIN) has been set for the card.

**Allowable Values:**

4 chars | | card.**reissue\_pan\_from\_card\_token**

string

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

**Allowable Values:**

Existing card token | | card.**new\_pan\_from\_card\_token**

string

Optional | Reissues the specified card (known as the "source" card) with a new primary account number (PAN).

**Allowable Values:**

Existing card token | | card.**state**

string

Required | Indicates the state of the card.

**Allowable Values:**

ACTIVE, SUSPENDED, TERMINATED, UNSUPPORTED, UNACTIVATED, LIMITED | | card.**state\_reason**

string

Required | Descriptive reason for why the card is in its current state. For example, "Card activated by cardholder".

**Allowable Values:**

255 char max | | card.**token**

string

Required | Unique identifier of the card.

**Allowable Values:**

Existing card token | | card.**translate\_pin\_from\_card\_token**

string

Optional | Copies the personal identification number (PIN) from the specified source card to the newly created card.

**Allowable Values:**

Existing card token | | card.**user\_token**

string

Required | Unique identifier of the cardholder.

**Allowable Values:**

Existing user token | | card\_acceptor

object

Optional | Contains information about the merchant.

**Allowable Values:**

Existing card\_acceptor object | | card\_acceptor.**address**

string

Optional | Card acceptor’s address. May be returned if the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests.

**Allowable Values:**

255 char max | | card\_acceptor.**business\_registration\_id**

string

Optional | Business registration identifier, as provided by the Visa card network.

**Allowable Values:**

255 char max | | card\_acceptor.**business\_registration\_id\_type**

string

Optional | Business registration identifier type, as provided by the Visa card network.

**Allowable Values:**

255 char max | | card\_acceptor.**city**

string

Optional | Card acceptor’s city.

**Allowable Values:**

40 char max | | card\_acceptor.**country\_code**

string

Optional | Card acceptor’s country code. May be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests.

**Allowable Values:**

Valid alpha-3 ISO 3166 country code | | card\_acceptor.**geographic\_coordinates**

string

Optional | For Mastercard only. Geographic coordinates of the card acceptor in latitudeE7,longitudeE7 format.

**Allowable Values:**

255 char max

**Example Value:**
3781100,-12226302 | | card\_acceptor.**legal\_business\_name**

string

Optional | Legal business name, as provided by the Visa card network.

**Allowable Values:**

255 char max | | card\_acceptor.**mcc**

string

Optional | Merchant category code (MCC).

**Allowable Values:**

Existing MCC | | card\_acceptor.**mcc\_groups**

array of strings

Optional | An array of mcc\_groups.

**Allowable Values:**

Valid array of one or more mcc\_groups | | card\_acceptor.**mid**

string

Optional | The merchant identifier.

**Allowable Values:**

255 char max | | card\_acceptor.**name**

string

Optional | Card acceptor’s name.

**Allowable Values:**

50 char max | | card\_acceptor.**network\_assigned\_id**

string

Optional | Identifier assigned by the card network.

**Allowable Values:**

255 char max | | card\_acceptor.**network\_mid**

string

Optional | The merchant identifier on the card network.

**Allowable Values:**

255 char max | | card\_acceptor.**poi**

object

Optional | Contains information about the point of sale, including details on how the card was presented.

Returned if provided by the card network, and the request uses Transaction Model v1 of the Marqeta Core API. Not returned for Transaction Model v2 requests.

**Allowable Values:**

card\_presence, cardholder\_presence, partial\_approval\_capable, pin\_present, special\_condition\_indicator, tid | | card\_acceptor.poi.**card\_presence**

string

Optional | Indicates whether the card was present during the transaction.

**Allowable Values:**

255 char max | | card\_acceptor.poi.**cardholder\_presence**

string

Optional | Indicates whether the cardholder was present during the transaction.

**Allowable Values:**

255 char max | | card\_acceptor.poi.**partial\_approval\_capable**

string

Optional | Indicates whether the card acceptor or terminal supports partial-approval transactions.

**Allowable Values:**

255 char max | | card\_acceptor.poi.**pin\_present**

string

Optional | Indicates whether the cardholder entered a PIN during the transaction.

**Allowable Values:**

255 char max | | card\_acceptor.poi.**special\_condition\_indicator**

string

Optional | Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction.

These transactions typically involve non-financial institutions.

**Allowable Values:**

CRYPTOCURRENCY\_PURCHASE, DEBT\_PAYMENT, QUASI\_CASH, CENTRAL\_BANK\_DIGITAL\_CURRENCY\_PURCHASE, STABLECOIN\_PURCHASE, BLOCKCHAIN\_NATIVE\_TOKEN\_PURCHASE, NON\_FUNGIBLE\_TOKEN\_PURCHASE, UNSPECIFIED | | card\_acceptor.poi.**tid**

string

Optional | Card acceptor or terminal identification number.

**Allowable Values:**

255 char max | | card\_acceptor.poi.**transaction\_initiated\_by**

string

Optional | Specifies the initiator of the transaction.

**Allowable Values:**

CONSUMER, MERCHANT, UNKNOWN | | card\_acceptor.poi.**transaction\_initiated\_category**

string

Optional | Specifies the category of a point-of-sale transaction.

**Allowable Values:**

CARD\_ON\_FILE, RECURRING\_VAR\_AMT\_FIXED\_FREQ, RECURRING\_PAYMENT, INSTALLMENT\_PAYMENT, UNSCHEDULED\_PAYMENT, PARTIAL\_SHIPMENT, DELAYED\_PAYMENT, NO\_SHOW, RESUBMISSION, DEFERRED\_BILLING, ACCOUNT\_INQUIRY, INCREMENTAL\_AUTHORIZATION, REAUTHORIZATION | | card\_acceptor.**postal\_code**

string

Optional | Card acceptor’s postal code.

**Allowable Values:**

255 char max | | card\_acceptor.**service\_geographic\_coordinates**

string

Optional | For Mastercard only. Geographic coordinates of the service provider in latitudeE7,longitudeE7 format.

**Allowable Values:**

255 char max

**Example Value:**
3781100,-12226302 | | card\_acceptor.**state**

string

Optional | State, provincial, territorial, or federal abbreviation (CA for California or CAN for Canada, for example).

For the complete list, see Valid state, provincial, territorial, and federal abbreviations.

**Note**: Non-US merchants may return more than 2 char for this field.

**Allowable Values:**

2 char max | | card\_acceptor.**country\_of\_origin**

string

Optional | The merchant’s country of origin.

A merchant’s country of origin can be different from the country in which the merchant is located. For example, embassies are physically located in countries that are not their country of origin: a Mexican embassy might be physically located in Singapore, but the country of origin is Mexico.

This field is included when the cardholder conducts a transaction with a government-controlled merchant using a Marqeta-issued card.

**Allowable Values:**

255 char max | | card\_acceptor.**transfer\_service\_provider\_name**

string

Optional | The name of the transfer service provider of a money transfer original credit transaction. This field is included when a transfer service provider participates in the transaction.

**Allowable Values:**

25 char max | | card\_acceptor.**merchant\_vat\_registration\_id**

string

Optional | The VAT registration identifier of the merchant.

**Allowable Values:**

255 char max | | card\_acceptor.**payment\_facilitator\_name**

string

Optional | The name of the payment facilitator, including the sub-merchant identifier, of an original credit transaction. This field is returned when a payment facilitator participates in the transaction.

**Allowable Values:**

25 char max | | card\_holder\_model

object

Optional | Contains information about a cardholder.

**Allowable Values:**

account\_holder\_group\_token, active, address1, address2, authentication, birth\_date, birth\_place, business\_token, city, company, corporate\_card\_holder, country, created\_time, email, first\_name, gender, honorific, id\_card\_expiration\_date, id\_card\_number, identifications, ip\_address, last\_modified\_time, last\_name, metadata, middle\_name, nationality, notes, parent\_token, passport\_expiration\_date, passport\_number, password, phone, postal\_code, ssn, state, status, title, token, uses\_parent\_account, zip | | card\_holder\_model.**account\_holder\_group\_token**

string

Optional | Associates the specified account holder group with the cardholder.

**Allowable Values:**

36 char max | | card\_holder\_model.**active**

boolean

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

**Allowable Values:**

true, false | | card\_holder\_model.**address1**

string

Optional | Cardholder’s address.

**Allowable Values:**

255 char max | | card\_holder\_model.**address2**

string

Optional | Additional address information for the cardholder.

**Allowable Values:**

255 char max | | card\_holder\_model.**authentication**

object

Optional | Contains the cardholder’s email address and password information.

**Allowable Values:**

email\_verified, email\_verified\_time, last\_password\_update\_channel, last\_password\_update\_time | | card\_holder\_model.authentication.**email\_verified**

boolean

Optional | Specifies whether the email address has been verified.

**Allowable Values:**

true, false | | card\_holder\_model.authentication.**email\_verified\_time**

datetime

Optional | Date and time when the email address was verified.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | card\_holder\_model.authentication.**last\_password\_update\_channel**

string

Optional | Specifies the channel through which the password was last changed.

**Allowable Values:**

USER\_CHANGE, USER\_RESET | | card\_holder\_model.authentication.**last\_password\_update\_time**

datetime

Optional | Date and time when the password was last changed.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | card\_holder\_model.**birth\_date**

string

Optional | Cardholder’s date of birth.

**Allowable Values:**

Format: yyyy-MM-dd | | card\_holder\_model.**birth\_place**

string

Optional | Country where the cardholder was born.

**Allowable Values:**

255 char max

ISO 3166 two-character country codes. For example, the country code for the United States is US.

The ISO maintains the full list of ISO-3166 country codes. | | card\_holder\_model.**business\_token**

string

Optional | Unique identifier of the business resource.

**Allowable Values:**

Existing business resource token | | card\_holder\_model.**city**

string

Optional | City where the cardholder resides.

**Allowable Values:**

40 char max | | card\_holder\_model.**company**

string

Optional | Company name.

**Allowable Values:**

255 char max | | card\_holder\_model.**corporate\_card\_holder**

boolean

Optional | Specifies if the cardholder holds a corporate card.

**Allowable Values:**

true, false | | card\_holder\_model.**country**

string

Optional | Country where the cardholder resides.

**Allowable Values:**

40 char max | | card\_holder\_model.**created\_time**

datetime

Required | Date and time when the resource was created, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | card\_holder\_model.**email**

string

Optional | Valid email address of the cardholder.

**Allowable Values:**

1–255 chars | | card\_holder\_model.**first\_name**

string

Optional | Cardholder’s first name.

**Allowable Values:**

40 char max | | card\_holder\_model.**gender**

string

Optional | Gender of the cardholder.

**Allowable Values:**

F, M | | card\_holder\_model.**honorific**

string

Optional | Cardholder’s title or prefix: Dr., Miss, Mr., Ms., and so on.

**Allowable Values:**

10 char max | | card\_holder\_model.**id\_card\_expiration\_date**

string

Optional | Expiration date of the cardholder’s identification.

**Allowable Values:**

Format: yyyy-MM-dd | | card\_holder\_model.**id\_card\_number**

string

Optional | Cardholder’s identification card number.

**Allowable Values:**

255 char max | | card\_holder\_model.**identifications**

array of objects

Optional | One or more objects containing identifications associated with the cardholder.

**Allowable Values:**

Valid array of one or more identifications objects | | card\_holder\_model.identifications\[].**expiration\_date**

string

Optional | Expiration date of the identification, if applicable.

**Allowable Values:**

Format: yyyy-MM-dd | | card\_holder\_model.identifications\[].**type**

string

Optional | Type of identification.

**Allowable Values:**

SSN, TIN, SIN, NIN, PASSPORT\_NUMBER, DRIVERS\_LICENSE, BUSINESS\_NUMBER, BUSINESS\_TAX\_ID, TAXPAYER\_REFERENCE | | card\_holder\_model.identifications\[].**value**

string

Optional | Number associated with the identification.

**Allowable Values:**

255 char max | | card\_holder\_model.**ip\_address**

string

Optional | Cardholder’s IP address.

**Allowable Values:**

39 char max | | card\_holder\_model.**last\_modified\_time**

datetime

Required | Date and time when the resource was last updated, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | card\_holder\_model.**last\_name**

string

Optional | Cardholder’s last name.

**Allowable Values:**

40 char max | | card\_holder\_model.**metadata**

object

Optional | Associates any additional metadata you provide with the cardholder.

**Allowable Values:**

You can define the names and values of up to 20 fields in the format "my\_name\_1": "my\_value\_1" | | card\_holder\_model.**middle\_name**

string

Optional | Cardholder’s middle name.

**Allowable Values:**

40 char max | | card\_holder\_model.**nationality**

string

Optional | Cardholder’s nationality.

**Allowable Values:**

255 char max | | card\_holder\_model.**notes**

string

Optional | Any additional information pertaining to the cardholder.

**Allowable Values:**

255 char max | | card\_holder\_model.**parent\_token**

string

Optional | Unique identifier of the parent user or business resource.

**Allowable Values:**

1–36 chars | | card\_holder\_model.**passport\_expiration\_date**

string

Optional | Expiration date of the cardholder’s passport.

**Allowable Values:**

Format: yyyy-MM-dd | | card\_holder\_model.**passport\_number**

string

Optional | Cardholder’s passport number.

**Allowable Values:**

40 char max | | card\_holder\_model.**password**

string

Optional | Password to the cardholder’s user account on the Marqeta platform.

**Allowable Values:**

1–255 chars | | card\_holder\_model.**phone**

string

Optional | Cardholder’s telephone number.

**Allowable Values:**

255 char max | | card\_holder\_model.**postal\_code**

string

Optional | Postal code of the cardholder’s address.

**Allowable Values:**

10 char max | | card\_holder\_model.**ssn**

string

Optional | Cardholder’s Social Security Number (SSN).

**Allowable Values:**

Nine digits only, no delimiters. | | card\_holder\_model.**state**

string

Optional | State or province where the cardholder resides.

**Allowable Values:**

2 char max | | card\_holder\_model.**status**

string

Optional | Specifies the status of the cardholder on the Marqeta platform.

**Allowable Values:**

UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED | | card\_holder\_model.**title**

string

Optional | Professional title of the cardholder, such as Chief Comptroller.

**Allowable Values:**

255 char max | | card\_holder\_model.**token**

string

Optional | Unique identifier of the cardholder.

**Allowable Values:**

1–36 chars | | card\_holder\_model.**uses\_parent\_account**

boolean

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

**Allowable Values:**

true, false | | card\_holder\_model.**zip**

string

Optional | United States ZIP code of the cardholder’s address.

**Allowable Values:**

10 char max | | card\_product\_token

string

Optional | Unique identifier of the card product.

**Allowable Values:**

36 char max | | card\_security\_code\_verification

object

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

**Allowable Values:**

Existing card\_security\_code\_verification object | | card\_security\_code\_verification.**response**

object

Required | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | card\_security\_code\_verification.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | card\_security\_code\_verification.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | card\_security\_code\_verification.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | card\_security\_code\_verification.**type**

string

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

- **CVV1** – the security code stored in the magnetic stripe on the card.
- **CVV2** – the security code printed on the card.
- **ICVV** – the security code stored on the chip of the card.
- **DCVV** – a dynamic security code used in some contactless payments when a card or device is tapped against the card reader.

**Allowable Values:**

CVV1, CVV2, ICVV, DCVV | | card\_token

string

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

**Allowable Values:**

36 char max | | cardholder\_authentication\_data

object

Optional | Contains authentication data for 3D Secure and digital wallet token transactions:

- electronic\_commerce\_indicator – The level of verification performed.
- verification\_result – The result of the verification.
- verification\_value\_created\_by – The transaction participant who determined the verification result.
- three\_ds\_message\_version – The 3D Secure message version used for authentication.
- authentication\_method – The 3D Secure authentication method.
- authentication\_status – The 3D Secure authentication status.
- acquirer\_exemption – Indicates a 3D Secure authentication exemption from the acquirer.
- issuer\_exemption – Indicates a 3D Secure authentication exemption from the issuer.
- cavv\_authentication\_amount – CAVV authentication amount.
- raw\_cavv\_data – Raw CAVV data provided by the card network.

**Allowable Values:**

Existing cardholder\_authentication\_data object | | cardholder\_authentication\_data.**acquirer\_exemption**

array of strings

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

**Allowable Values:**

MERCHANT\_INITIATED\_TRANSACTION, TRANSACTION\_RISK\_ANALYSIS, RECURRING\_PAYMENT, LOW\_VALUE\_PAYMENT, SCA\_PERFORMED, SECURE\_CORPORATE\_PAYMENT, AUTHENTICATION\_OUTAGE\_EXCEPTION | | cardholder\_authentication\_data.**authentication\_method**

string

Optional | Specifies the 3D Secure authentication method.

**Allowable Values:**

null, AUDIO\_CALL, BEHAVIORAL\_BIOMETRICS, BIOMETRIC, BIOMETRIC\_FACE, BIOMETRIC\_FINGERPRINT, CHALLENGE, DECOUPLED, DELEGATED\_TRUSTED\_AUTHENTICATION, FRICTIONLESS, FRICTIONLESS\_FIDO, FRICTIONLESS\_SMART\_ATTEMPTS, IN\_APP\_LOGIN, KNOWLEDGE\_BASED, MDES, OOB, OOB\_OTHER, OTHER, OTP, OTP\_SMS, OTP\_EMAIL, SECURE\_PAYMENT\_CONFM, STAND\_IN\_FRICTIONLESS, VIDEO\_CALL, VOICE\_RECOGNITION, WEB\_AUTHN, OTHER, UNKNOWN | | cardholder\_authentication\_data.**authentication\_status**

string

Optional | Specifies the status of the 3D Secure authentication:

- ATTEMPTED: Indicates that 3D Secure authentication was requested and processed by the card network.
- DATA\_SHARE\_EXEMPTED: Indicates that 3D Secure authentication was for information only and exempted.
- EXEMPTED: Indicates that 3D Secure authentication was requested but the challenge was exempted.
- EXEMPTION\_CLAIMED: Indicates that 3D Secure authentication was exempted because acquirer transaction risk analysis (TRA) was already performed.
- SCA\_EXEMPTION: Indicates that 3D Secure authentication was exempted because strong customer authentication (SCA) was already performed.
- SUCCESSFUL: Indicates that 3D Secure authentication was successful.
- SUCCESSFUL\_NON\_PAYMENT: Indicates that 3D Secure non-payment authentication was successful.
- THREEDS\_REQUESTER\_DATA\_SHARE\_EXEMPTION: Status is deprecated and will be removed from a future release of the Marqeta platform. After June 2023, use DATA\_SHARE\_EXEMPTION instead.
- THREEDS\_REQUESTER\_SCA\_EXEMPTION: Status is deprecated and will be removed in a June 2023 release of the Marqeta platform. After June 2023, use SCA\_EXEMPTION instead.
- THREEDS\_REQUESTER\_TRA\_EXEMPTION: Status is deprecated and will be removed in a June 2023 release of the Marqeta platform. After June 2023, use EXEMPTION\_CLAIMED instead.
- UNAVAILABLE:

- For Visa transactions, this status indicates that 3D Secure authentication was requested, but Marqeta’s access control server (ACS) was not available.
- For Mastercard transactions, this status indicates that 3D Secure authentication was not available.

**Allowable Values:**

ATTEMPTED, DATA\_SHARE\_EXEMPTED, EXEMPTED, EXEMPTION\_CLAIMED, SCA\_EXEMPTION, SUCCESSFUL, SUCCESSFUL\_NON\_PAYMENT, THREEDS\_REQUESTER\_DATA\_SHARE\_EXEMPTION, THREEDS\_REQUESTER\_SCA\_EXEMPTION, THREEDS\_REQUESTER\_TRA\_EXEMPTION, UNAVAILABLE | | cardholder\_authentication\_data.**electronic\_commerce\_indicator**

string

Optional | Status of the 3D Secure or digital wallet token transaction authentication attempt, as provided by a transaction participant.

- authentication\_attempted: Merchant attempted to authenticate, but either the issuer or the cardholder does not participate in 3D Secure or card tokenization.
- authentication\_successful: Cardholder authentication successful.
- no\_authentication: Non-authenticated e-commerce transaction.

**Allowable Values:**

authentication\_attempted, authentication\_successful, no\_authentication | | cardholder\_authentication\_data.**issuer\_exemption**

string

Optional | Indicates a 3D Secure authentication exemption from the issuer. This field is returned if it is included in the transaction data from the card network.

**Allowable Values:**

SCA\_LOW\_VALUE\_PAYMENT | | cardholder\_authentication\_data.**three\_ds\_message\_version**

string

Optional | Specifies the 3D Secure message version used for authentication.

**Allowable Values:**

1.0.2, 2.1.0, 2.2.0 | | cardholder\_authentication\_data.**three\_ds\_reference\_id**

string

Optional | The 3D Secure authentication indicator, as provided by the Mastercard card network.

**Allowable Values:**

255 char max | | cardholder\_authentication\_data.**verification\_result**

string

Optional | Result of cardholder authentication verification value (CAVV) or accountholder authentication value (AAV) verification performed by the card network.

- failed
- not\_present
- not\_provided
- not\_verified
- not\_verified\_authentication\_outage
- verified
- verified\_amount\_checked
- verified\_amount\_greater\_than\_20\_percent: For Mastercard AAV verification, indicates that the original authentication amount and final authorization amount are mismatched, and that the final authorization amount exceeds the original authentication amount by more than 20%. This 20% margin falls outside Mastercard’s suggested tolerance for what a European cardholder might reasonably expect when the total transaction amount is not known in advance.
- verified\_amount\_less\_than\_20\_percent: For Mastercard AAV verification, indicates that the original authentication amount and final authorization amount are mismatched, and that the final authorization amount exceeds the original authentication amount by 20% or less. This 20% margin falls within Mastercard’s suggested tolerance for what a European cardholder might reasonably expect when the total transaction amount is not known in advance.
- not\_verified\_mac\_key\_validation\_passed: For Mastercard only. This field is present when the transaction passes MAC key validation but Dynamic Linking was not performed by the Mastercard card network due to system connectivity issues.
- not\_verified\_mac\_key\_validation\_failed: For Mastercard only. This field is present when the transaction fails MAC key validation and Dynamic Linking was not performed by the Mastercard card network due to system connectivity issues.

**Allowable Values:**

failed, not\_present, not\_provided, not\_verified, not\_verified\_authentication\_outage, verified, verified\_amount\_checked, verified\_amount\_greater\_than\_20\_percent, verified\_amount\_less\_than\_20\_percent, not\_verified\_mac\_key\_validation\_passed, not\_verified\_mac\_key\_validation\_failed | | cardholder\_authentication\_data.**verification\_value\_created\_by**

string

Optional | Transaction participant who determined the verification result.

**Allowable Values:**

issuer\_acs, issuer\_attempts\_server, network, network\_attempts\_server | | cardholder\_authentication\_data.**cavv\_authentication\_amount**

string

Optional | Authentication amount from the cardholder authentication verification value (CAVV) used to validate an authorization. This field is returned if it is included in the transaction data from the card network.

To enable this field, contact your Marqeta representative.

**Allowable Values:**

255 char max | | cardholder\_authentication\_data.**raw\_cavv\_data**

string

Optional | Raw cardholder authentication verification value provided by the card network. This field is returned if it is included in the transaction data from the card network.

To enable this field, contact your Marqeta representative.

**Allowable Values:**

255 char max | | cash\_back\_amount

decimal

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

**Allowable Values:**

decimal

**Format:**
0.00 | | chargeback

object

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

**Allowable Values:**

Existing chargeback object | | chargeback.**amount**

decimal

Required | Amount of the chargeback.

**Allowable Values:**

0.01 min | | chargeback.**channel**

string

Required | Channel the chargeback came through.

**Allowable Values:**

GATEWAY, GATEWAY\_AUTOMATED, ISSUER, ISSUER\_AUTOMATED | | chargeback.**created\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | chargeback.**credit\_user**

boolean

Required | Whether to credit the user for the chargeback amount.

**Allowable Values:**

true, false | | chargeback.**last\_modified\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | chargeback.**memo**

string

Optional | Additional comments about the chargeback.

**Allowable Values:**

1–1024 chars | | chargeback.**network**

string

Required | Network handling the chargeback.

**Allowable Values:**

MARQETA, DISCOVER, MASTERCARD, PULSE, VISA | | chargeback.**network\_case\_id**

string

Optional | Network-assigned identifier of the chargeback.

**Allowable Values:**

50 char max | | chargeback.**reason\_code**

string

Optional | Identifies the standardized reason for the chargeback.

**Allowable Values:**

See The reason\_code field in the Disputes (Visa) API reference. | | chargeback.**state**

string

Required | State of the case.

**Allowable Values:**

INITIATED, REPRESENTMENT, PREARBITRATION, ARBITRATION, CASE\_WON, CASE\_LOST, NETWORK\_REJECTED, WITHDRAWN | | chargeback.**token**

string

Required | Unique identifier of the chargeback.

**Allowable Values:**

1–36 chars | | chargeback.**transaction\_token**

string

Required | Unique identifier of the transaction being charged back.

**Allowable Values:**

1–36 chars | | clearing\_record\_sequence\_number

string

Optional | A sequence number that identifies a specific clearing message among multiple clearing messages for an authorization.

**Allowable Values:**

Sequence number returned in the clearing record | | created\_time

datetime

Optional | Date and time when the Marqeta platform created the transaction entry, in UTC format. For example, when Marqeta processed the clearing record for a refund.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | currency\_code

string

Optional | Currency type of the transaction.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | currency\_conversion

object

Optional | Contains information about currency conversion.

**Allowable Values:**

Existing currency\_conversion object | | currency\_conversion.**network**

object

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

**Allowable Values:**

Existing network object | | currency\_conversion.network.**conversion\_rate**

decimal

Optional | Conversion rate between the origination currency and the settlement currency.

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

**Allowable Values:**

Current conversion rate.

**NOTE:** A value of 0 or 1 indicates no conversion; the currencies are the same. | | currency\_conversion.network.**dynamic\_currency\_conversion**

boolean

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

**Allowable Values:**

true, false | | currency\_conversion.network.**original\_amount**

decimal

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

**Allowable Values:**

Decimal amount. | | currency\_conversion.network.**original\_currency\_code**

string

Optional | Currency type of the origination currency.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | currency\_conversion.network.**settlement\_data**

object

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

**Allowable Values:**

Existing settlement\_data object | | currency\_conversion.network.settlement\_data.**amount**

decimal

Optional | The settled amount.

**Allowable Values:**

decimal

**Format:**
0.00 | | currency\_conversion.network.settlement\_data.**conversion\_rate**

decimal

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

Conversion rate between the origination currency and the settlement currency.

**Allowable Values:**

Current conversion rate.

**NOTE:** A value of 0 or 1 indicates no conversion; the currencies are the same. | | currency\_conversion.network.settlement\_data.**currency\_code**

string

Optional | The ISO 4217 code of the currency used in the transaction.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | digital\_commerce\_authentication\_indicator

string

Optional | Visa Digital Commerce Authentication Program (VDCAP) indicator for U.S. domestic card-not-present transactions. Indicates the presence of key data elements, along with the eligible method used to share authentication data.

- **01:** Visa Digital Authentication Framework
- **02:** Visa Secure
- **03:** Visa data only
- **04:** Visa Payment Passkey with Visa Secure
- **05:** Visa Payment Passkey with Visa Token Service
- **06:** IDX 3rd party
- **07:** Visa Token Service data only

**Allowable Values:**

01, 02, 03, 04, 05, 06, 07 | | digital\_commerce\_authentication\_program

object

Optional | Contains consumer contact and billing address data received in Visa's Digital Commerce Authentication Program (DCAP) Field 56 for authenticated e-commerce transactions.
Populated only for DCAP-authenticated transactions.

**Allowable Values:**

`phone_number`, `email_address`, `billing_address_line_1`, `billing_address_line_2`, `billing_street_name`, `billing_building_number`, `billing_postal_code`, `billing_city`, `billing_subdivision_minor`, `billing_subdivision_major`, `billing_country_code` | | digital\_commerce\_authentication\_program.**phone\_number**

string

Optional | Cardholder phone number provided through DCAP.

**Allowable Values:**

16 char max | | digital\_commerce\_authentication\_program.**email\_address**

string

Optional | Cardholder email address provided through DCAP.

**Allowable Values:**

99 char max | | digital\_commerce\_authentication\_program.**billing\_address\_line\_1**

string

Optional | First line of the cardholder billing address.

**Allowable Values:**

50 char max | | digital\_commerce\_authentication\_program.**billing\_address\_line\_2**

string

Optional | Second line of the cardholder billing address.

**Allowable Values:**

50 char max | | digital\_commerce\_authentication\_program.**billing\_street\_name**

string

Optional | Street name of the cardholder billing address.

**Allowable Values:**

50 char max | | digital\_commerce\_authentication\_program.**billing\_building\_number**

string

Optional | Building or house number of the cardholder billing address.

**Allowable Values:**

16 char max | | digital\_commerce\_authentication\_program.**billing\_postal\_code**

string

Optional | Postal or ZIP code of the cardholder billing address.

**Allowable Values:**

16 char max | | digital\_commerce\_authentication\_program.**billing\_city**

string

Optional | City of the cardholder billing address.

**Allowable Values:**

25 char max | | digital\_commerce\_authentication\_program.**billing\_subdivision\_minor**

string

Optional | ISO 3166-2 minor country subdivision code of the billing address.

**Allowable Values:**

16 char max | | digital\_commerce\_authentication\_program.**billing\_subdivision\_major**

string

Optional | ISO 3166-2 major country subdivision (state or province) code of the billing address.

**Allowable Values:**

3 char max | | digital\_commerce\_authentication\_program.**billing\_country\_code**

string

Optional | ISO 3166-1 country code of the billing address.

**Allowable Values:**

3 char max | | digital\_wallet\_token

object

Optional | Contains information about the digital wallet that funded the transaction.

Returned for all transactions funded by a digital wallet or related to digital wallet token provisioning.

For more on digital wallets, see the Digital Wallets Management API reference and Digital Wallets and Tokenization developer guide.

**Allowable Values:**

address\_verification, card\_token, created\_time, device, fulfillment\_status, issuer\_eligibility\_decision, last\_modified\_time, metadata, state, state\_reason, token, token\_service\_provider, user, wallet\_provider\_profile | | digital\_wallet\_token.**address\_verification**

object

Optional | Contains address verification information.

**Allowable Values:**

name, postal\_code, street\_address, zip | | digital\_wallet\_token.address\_verification.**name**

string

Optional | Name of the cardholder.

**Allowable Values:**

40 char max | | digital\_wallet\_token.address\_verification.**postal\_code**

string

Optional | Postal code.

**Allowable Values:**

10 char max | | digital\_wallet\_token.address\_verification.**street\_address**

string

Optional | Street address provided by the cardholder.

**Allowable Values:**

40 char max | | digital\_wallet\_token.address\_verification.**zip**

string

Optional | United States ZIP code.

**Allowable Values:**

10 char max | | digital\_wallet\_token.**card\_token**

string

Optional | Unique identifier of the card.

**Allowable Values:**

Existing card token | | digital\_wallet\_token.**created\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | digital\_wallet\_token.**device**

object

Optional | Contains information related to the device being provisioned.

**Allowable Values:**

device\_id, ip\_address, language\_code, location, name, phone\_number, token, type | | digital\_wallet\_token.device.**device\_id**

string

Optional | Identity number of the device.

**Allowable Values:**

24 char max | | digital\_wallet\_token.device.**ip\_address**

string

Optional | Device’s IP address.

**Allowable Values:**

IP address format, 50 char max | | digital\_wallet\_token.device.**language\_code**

string

Optional | Language the device is configured to use.

**Allowable Values:**

50 char max | | digital\_wallet\_token.device.**location**

string

Optional | Geographic coordinates of the device.

**Allowable Values:**

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

**NOTE:** Both the longitude and latitude are prefixed with either a + or - symbol, for example: +42.29/-71.07. | | digital\_wallet\_token.device.**name**

string

Optional | Name of the device.

**Allowable Values:**

50 char max | | digital\_wallet\_token.device.**phone\_number**

string

Optional | Device’s telephone number.

**Allowable Values:**

50 char max | | digital\_wallet\_token.device.**token**

string

Optional | Unique identifier of the device object.

**Allowable Values:**

36 char max | | digital\_wallet\_token.device.**type**

string

Optional | Type of device being provisioned.

**Allowable Values:**

MOBILE\_PHONE, WATCH, TABLET, MOBILE\_PHONE\_OR\_TABLET, VEHICLE, APPLIANCE, LAPTOP, GAMING\_DEVICE, WEARABLE\_DEVICE, UNKNOWN | | digital\_wallet\_token.**fulfillment\_status**

string

Optional | Digital wallet token’s provisioning status.

For fulfillment status descriptions, see Create digital wallet token transition.

**Allowable Values:**

DECISION\_RED, DECISION\_YELLOW, DECISION\_GREEN, REJECTED, PROVISIONED | | digital\_wallet\_token.**issuer\_eligibility\_decision**

string

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

- **0000** – The token should be provisioned.
- **token.activation.verification.required** – Provisioning is pending; further action is required for completion.

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

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

**Allowable Values:**

0000, cardaccount.verified, card.suspicious, token.activation.verification.required, token.activation-request.decline, card.not.active, invalid.cid, card.expired, card.suspended, cardholder.not.active | | digital\_wallet\_token.**last\_modified\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | digital\_wallet\_token.**metadata**

object

Optional | Contains additional information about the digital wallet token.

**Allowable Values:**

cardproduct\_preferred\_notification\_language, issuer\_product\_config\_id | | digital\_wallet\_token.metadata.**cardproduct\_preferred\_notification\_language**

string

Optional | Language specified in the config.transaction\_controls.notification\_language field of the card product:

- **ces** – Czech
- **deu** – German
- **eng** – English
- **fra** – French
- **ell** – Greek
- **ita** – Italian
- **nld** – Dutch
- **pol** – Polish
- **por** – Portuguese
- **ron** – Romanian
- **spa** – Spanish
- **swe** – Swedish

By default, notifications are sent in English.

The ISO maintains the full list of ISO 3166 two- and three-digit numeric country codes.

**Allowable Values:**

ces, deu, eng, fra, ell, ita, nld, pol, por, ron, spa, swe | | digital\_wallet\_token.metadata.**issuer\_product\_config\_id**

string

Optional | Unique identifier of the product configuration on the Marqeta platform.

**Allowable Values:**

255 char max | | digital\_wallet\_token.**state**

string

Optional | State of the digital wallet token.

For state descriptions, see Transitioning Token States.

**Allowable Values:**

REQUESTED, REQUEST\_DECLINED, ACTIVE, SUSPENDED, TERMINATED | | digital\_wallet\_token.**state\_reason**

string

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

**Allowable Values:**

255 char max | | digital\_wallet\_token.**token**

string

Optional | Unique identifier of the digital wallet token.

**Allowable Values:**

Existing digital wallet token. | | digital\_wallet\_token.**token\_service\_provider**

object

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

**Allowable Values:**

correlation\_id, pan\_reference\_id, token\_assurance\_level, token\_eligibility\_decision, token\_expiration, token\_pan, token\_reference\_id, token\_requestor\_id, token\_requestor\_name, token\_score, token\_type | | digital\_wallet\_token.token\_service\_provider.**correlation\_id**

string

Optional | For Mastercard only. Unique value representing a tokenization request.

**Allowable Values:**

Existing correlation identifier | | digital\_wallet\_token.token\_service\_provider.**pan\_reference\_id**

string

Optional | Unique identifier of the digital wallet token primary account number (PAN) within the card network.

**Allowable Values:**

Existing PAN Reference ID | | digital\_wallet\_token.token\_service\_provider.**token\_assurance\_level**

string

Optional | For Mastercard only. Represents the confidence level in the digital wallet token.

**Allowable Values:**

0-99 | | digital\_wallet\_token.token\_service\_provider.**token\_eligibility\_decision**

string

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

**Allowable Values:**

DECISION\_RED, DECISION\_YELLOW, DECISION\_GREEN | | digital\_wallet\_token.token\_service\_provider.**token\_expiration**

string

Optional | Expiration date of the digital wallet token.

**Allowable Values:**

Format: MMyy | | digital\_wallet\_token.token\_service\_provider.**token\_pan**

string

Optional | Primary account number (PAN) of the digital wallet token.

**Allowable Values:**

16 char max | | digital\_wallet\_token.token\_service\_provider.**token\_reference\_id**

string

Optional | Unique identifier of the digital wallet token within the card network.

**Allowable Values:**

Existing Token Reference ID | | digital\_wallet\_token.token\_service\_provider.**token\_requestor\_id**

string

Optional | Unique numerical identifier of the token requestor within the card network. These ID numbers map to token\_requestor\_name field values as follows:

**Mastercard**

- 50110030273 – APPLE\_PAY
- 50120834693 – ANDROID\_PAY
- 50139059239 – SAMSUNG\_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 | | digital\_wallet\_token.token\_service\_provider.**token\_requestor\_name**

string

Optional | Name of the token requestor within the card network.

**NOTE:** The list of example values for this field is maintained by the card networks and is subject to change.

**Allowable Values:**

255 char max

**Example Values:**

- **Mastercard** – APPLE\_PAY, ANDROID\_PAY, SAMSUNG\_PAY
- **Visa** – APPLE\_PAY, ANDROID\_PAY, SAMSUNG\_PAY, MICROSOFT\_PAY, VISA\_CHECKOUT, FACEBOOK, NETFLIX, FITBIT\_PAY, GARMIN\_PAY | | digital\_wallet\_token.token\_service\_provider.**token\_score**

string

Optional | Token score assigned by the digital wallet.

**Allowable Values:**

25 char max | | digital\_wallet\_token.token\_service\_provider.**token\_type**

string

Optional | Type of the digital wallet token.

**Allowable Values:**

MERCHANT\_CARD\_ON\_FILE, DEVICE\_SECURE\_ELEMENT, DEVICE\_CLOUD\_BASED, ECOMMERCE\_DIGITAL\_WALLET | | digital\_wallet\_token.**transaction\_device**

object

Optional | Contains information about the device used in the transaction to enhance the risk decisioning process. Use this data to improve fraud prevention and dispute resolution.

**Allowable Values:**

binding\_id, ip\_address, location, phone\_number | | digital\_wallet\_token.transaction\_device.**binding\_id**

string

Optional | Unique identifier of the data component bound to the credential.

**Allowable Values:**

48 char max | | digital\_wallet\_token.transaction\_device.**ip\_address**

string

Optional | IP address of the device. The presence of the IP address helps determine if the transaction was initiated from an unusual network, helping establish a pattern of safe device usage that further confirms the authenticity of the consumer who initiated the transaction.

**Allowable Values:**

IP address format, 39 char max | | digital\_wallet\_token.transaction\_device.**location**

string

Optional | Geographic coordinates of the device. Contains the latitude and longitude of the device used when the cardholder was authenticated during checkout. This field helps to determine if the transaction was initiated from an unexpected location.

**Allowable Values:**

Latitude and longitude in DDD.DD/DDD.DD format. | | digital\_wallet\_token.transaction\_device.**phone\_number**

string

Optional | Telephone number of the device. Contains the phone number that was used to authenticate the consumer during checkout, or the consumer’s preferred phone number. The presence of the phone number helps establish the consumer’s authenticity when matching the phone number provided during checkout to a list of known phone numbers for the consumer.

**Allowable Values:**

15 char max | | digital\_wallet\_token.**user**

object

Optional | Contains information about a cardholder.

**Allowable Values:**

account\_holder\_group\_token, active, address1, address2, authentication, birth\_date, birth\_place, business\_token, city, company, corporate\_card\_holder, country, created\_time, email, first\_name, gender, honorific, id\_card\_expiration\_date, id\_card\_number, identifications, ip\_address, last\_modified\_time, last\_name, metadata, middle\_name, nationality, notes, parent\_token, passport\_expiration\_date, passport\_number, password, phone, postal\_code, ssn, state, status, title, token, uses\_parent\_account, zip | | digital\_wallet\_token.user.**account\_holder\_group\_token**

string

Optional | Associates the specified account holder group with the cardholder.

**Allowable Values:**

36 char max | | digital\_wallet\_token.user.**active**

boolean

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

**Allowable Values:**

true, false | | digital\_wallet\_token.user.**address1**

string

Optional | Cardholder’s address.

**Allowable Values:**

255 char max | | digital\_wallet\_token.user.**address2**

string

Optional | Additional address information for the cardholder.

**Allowable Values:**

255 char max | | digital\_wallet\_token.user.**authentication**

object

Optional | Contains the cardholder’s email address and password information.

**Allowable Values:**

email\_verified, email\_verified\_time, last\_password\_update\_channel, last\_password\_update\_time | | digital\_wallet\_token.user.authentication.**email\_verified**

boolean

Optional | Specifies whether the email address has been verified.

**Allowable Values:**

true, false | | digital\_wallet\_token.user.authentication.**email\_verified\_time**

datetime

Optional | Date and time when the email address was verified.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | digital\_wallet\_token.user.authentication.**last\_password\_update\_channel**

string

Optional | Specifies the channel through which the password was last changed.

**Allowable Values:**

USER\_CHANGE, USER\_RESET | | digital\_wallet\_token.user.authentication.**last\_password\_update\_time**

datetime

Optional | Date and time when the password was last changed.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | digital\_wallet\_token.user.**birth\_date**

string

Optional | Cardholder’s date of birth.

**Allowable Values:**

Format: yyyy-MM-dd | | digital\_wallet\_token.user.**birth\_place**

string

Optional | Country where the cardholder was born.

**Allowable Values:**

255 char max

ISO 3166 two-character country codes. For example, the country code for the United States is US.

The ISO maintains the full list of ISO-3166 country codes. | | digital\_wallet\_token.user.**business\_token**

string

Optional | Unique identifier of the business resource.

**Allowable Values:**

Existing business resource token | | digital\_wallet\_token.user.**city**

string

Optional | City where the cardholder resides.

**Allowable Values:**

40 char max | | digital\_wallet\_token.user.**company**

string

Optional | Company name.

**Allowable Values:**

255 char max | | digital\_wallet\_token.user.**corporate\_card\_holder**

boolean

Optional | Specifies if the cardholder holds a corporate card.

**Allowable Values:**

true, false | | digital\_wallet\_token.user.**country**

string

Optional | Country where the cardholder resides.

**Allowable Values:**

40 char max | | digital\_wallet\_token.user.**created\_time**

datetime

Required | Date and time when the resource was created, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | digital\_wallet\_token.user.**email**

string

Optional | Valid email address of the cardholder.

**Allowable Values:**

1–255 chars | | digital\_wallet\_token.user.**first\_name**

string

Optional | Cardholder’s first name.

**Allowable Values:**

40 char max | | digital\_wallet\_token.user.**gender**

string

Optional | Gender of the cardholder.

**Allowable Values:**

F, M | | digital\_wallet\_token.user.**honorific**

string

Optional | Cardholder’s title or prefix: Dr., Miss, Mr., Ms., and so on.

**Allowable Values:**

10 char max | | digital\_wallet\_token.user.**id\_card\_expiration\_date**

string

Optional | Expiration date of the cardholder’s identification.

**Allowable Values:**

Format: yyyy-MM-dd | | digital\_wallet\_token.user.**id\_card\_number**

string

Optional | Cardholder’s identification card number.

**Allowable Values:**

255 char max | | digital\_wallet\_token.user.**identifications**

array of objects

Optional | One or more objects containing identifications associated with the cardholder.

**Allowable Values:**

Valid array of one or more identifications objects | | digital\_wallet\_token.user.identifications\[].**expiration\_date**

string

Optional | Expiration date of the identification, if applicable.

**Allowable Values:**

Format: yyyy-MM-dd | | digital\_wallet\_token.user.identifications\[].**type**

string

Optional | Type of identification.

**Allowable Values:**

SSN, TIN, SIN, NIN, PASSPORT\_NUMBER, DRIVERS\_LICENSE, BUSINESS\_NUMBER, BUSINESS\_TAX\_ID, TAXPAYER\_REFERENCE | | digital\_wallet\_token.user.identifications\[].**value**

string

Optional | Number associated with the identification.

**Allowable Values:**

255 char max | | digital\_wallet\_token.user.**ip\_address**

string

Optional | Cardholder’s IP address.

**Allowable Values:**

39 char max | | digital\_wallet\_token.user.**last\_modified\_time**

datetime

Required | Date and time when the resource was last updated, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | digital\_wallet\_token.user.**last\_name**

string

Optional | Cardholder’s last name.

**Allowable Values:**

40 char max | | digital\_wallet\_token.user.**metadata**

object

Optional | Associates any additional metadata you provide with the cardholder.

**Allowable Values:**

You can define the names and values of up to 20 fields in the format "my\_name\_1": "my\_value\_1" | | digital\_wallet\_token.user.**middle\_name**

string

Optional | Cardholder’s middle name.

**Allowable Values:**

40 char max | | digital\_wallet\_token.user.**nationality**

string

Optional | Cardholder’s nationality.

**Allowable Values:**

255 char max | | digital\_wallet\_token.user.**notes**

string

Optional | Any additional information pertaining to the cardholder.

**Allowable Values:**

255 char max | | digital\_wallet\_token.user.**parent\_token**

string

Optional | Unique identifier of the parent user or business resource.

**Allowable Values:**

1–36 chars | | digital\_wallet\_token.user.**passport\_expiration\_date**

string

Optional | Expiration date of the cardholder’s passport.

**Allowable Values:**

Format: yyyy-MM-dd | | digital\_wallet\_token.user.**passport\_number**

string

Optional | Cardholder’s passport number.

**Allowable Values:**

40 char max | | digital\_wallet\_token.user.**password**

string

Optional | Password to the cardholder’s user account on the Marqeta platform.

**Allowable Values:**

1–255 chars | | digital\_wallet\_token.user.**phone**

string

Optional | Cardholder’s telephone number.

**Allowable Values:**

255 char max | | digital\_wallet\_token.user.**postal\_code**

string

Optional | Postal code of the cardholder’s address.

**Allowable Values:**

10 char max | | digital\_wallet\_token.user.**ssn**

string

Optional | Cardholder’s Social Security Number (SSN).

**Allowable Values:**

Nine digits only, no delimiters. | | digital\_wallet\_token.user.**state**

string

Optional | State or province where the cardholder resides.

**Allowable Values:**

2 char max | | digital\_wallet\_token.user.**status**

string

Optional | Specifies the status of the cardholder on the Marqeta platform.

**Allowable Values:**

UNVERIFIED, LIMITED, ACTIVE, SUSPENDED, CLOSED | | digital\_wallet\_token.user.**title**

string

Optional | Professional title of the cardholder, such as Chief Comptroller.

**Allowable Values:**

255 char max | | digital\_wallet\_token.user.**token**

string

Optional | Unique identifier of the cardholder.

**Allowable Values:**

1–36 chars | | digital\_wallet\_token.user.**uses\_parent\_account**

boolean

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

**Allowable Values:**

true, false | | digital\_wallet\_token.user.**zip**

string

Optional | United States ZIP code of the cardholder’s address.

**Allowable Values:**

10 char max | | digital\_wallet\_token.**wallet\_provider\_profile**

object

Optional | Contains information held and provided by the digital wallet provider.

**Allowable Values:**

account, device\_score, pan\_source, reason\_code, recommendation\_reasons, risk\_assessment | | digital\_wallet\_token.wallet\_provider\_profile.**account**

object

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

**Allowable Values:**

email\_address, id, score | | digital\_wallet\_token.wallet\_provider\_profile.account.**email\_address**

string

Optional | Digital wallet provider’s email address for the cardholder.

**Allowable Values:**

255 char max | | digital\_wallet\_token.wallet\_provider\_profile.account.**id**

string

Optional | Digital wallet provider’s identity number for the cardholder.

**Allowable Values:**

20 char max | | digital\_wallet\_token.wallet\_provider\_profile.account.**score**

string

Optional | Score from the digital wallet provider.

**Allowable Values:**

50 char max | | digital\_wallet\_token.wallet\_provider\_profile.**device\_score**

string

Optional | Score from the device.

**Allowable Values:**

50 char max | | digital\_wallet\_token.wallet\_provider\_profile.**pan\_source**

string

Optional | Source from which the digital wallet provider obtained the card primary account number (PAN).

**Allowable Values:**

KEY\_ENTERED, ON\_FILE, MOBILE\_BANKING\_APP | | digital\_wallet\_token.wallet\_provider\_profile.**reason\_code**

string

Optional | Reason for the wallet provider’s provisioning decision.

- **01** – Cardholder’s wallet account is too new relative to launch.
- **02** – Cardholder’s wallet account is too new relative to provisioning request.
- **03** – Cardholder’s wallet account/card pair is newer than date threshold.
- **04** – Changes made to account data within the account threshold.
- **05** – Suspicious transactions linked to this account.
- **06** – Account has not had activity in the last year.
- **07** – Suspended cards in the secure element.
- **08** – Device was put in lost mode in the last seven days for longer than the duration threshold.
- **09** – The number of provisioning attempts on this device in 24 hours exceeds threshold.
- **0A** – There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours.
- **0B** – The card provisioning attempt contains a distinct name in excess of the threshold.
- **0C** – The device score is less than 3.
- **0D** – The account score is less than 4.
- **0E** – Device provisioning location outside of the cardholder’s wallet account home country.
- **0G** – Suspect fraud.

**Allowable Values:**

01, 02, 03, 04, 05, 06, 07, 08, 09, 0A, 0B, 0C, 0D, 0E, 0G | | digital\_wallet\_token.wallet\_provider\_profile.**recommendation\_reasons**

array of strings

Optional | Array of recommendation reasons from the digital wallet provider.

**Allowable Values:**

Valid array of one or more recommendation reasons | | digital\_wallet\_token.wallet\_provider\_profile.**risk\_assessment**

object

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

**Allowable Values:**

score, version | | digital\_wallet\_token.wallet\_provider\_profile.risk\_assessment.**score**

string

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

**Allowable Values:**

DECISION\_RED, DECISION\_YELLOW, DECISION\_GREEN | | digital\_wallet\_token.wallet\_provider\_profile.risk\_assessment.**version**

string

Optional | Wallet provider’s risk assessment version.

**Allowable Values:**

Version information, as provided by the wallet provider | | direct\_deposit

object

Optional | Contains information about a direct deposit.

**Allowable Values:**

Existing direct\_deposit object | | direct\_deposit.**amount**

decimal

Optional | Amount being debited or credited.

**Allowable Values:**

decimal

**Format:**
0.00 | | direct\_deposit.**business\_token**

string

Optional | The unique identifier of the business account holder.

**Allowable Values:**

Existing business token | | direct\_deposit.**company\_discretionary\_data**

string

Optional | Company-specific data provided by the direct deposit originator.

**Allowable Values:**

20 char max | | direct\_deposit.**company\_entry\_description**

string

Optional | Company-specific data provided by the direct deposit originator.

**Allowable Values:**

20 char max | | direct\_deposit.**company\_identification**

string

Optional | Alphanumeric code that identifies the direct deposit originator.

**Allowable Values:**

10 char max | | direct\_deposit.**company\_name**

string

Optional | Name of the direct deposit originator.

**Allowable Values:**

16 char max | | direct\_deposit.**created\_time**

datetime

Optional | Date and time when the direct deposit account was created.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | direct\_deposit.**direct\_deposit\_account\_token**

string

Optional | The unique identifier of the direct deposit account.

**Allowable Values:**

Existing direct deposit account token | | direct\_deposit.**individual\_identification\_number**

string

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

**Allowable Values:**

255 char max | | direct\_deposit.**individual\_name**

string

Optional | Name of the direct deposit recipient.

**Allowable Values:**

22 char max | | direct\_deposit.**last\_modified\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | direct\_deposit.**settlement\_date**

datetime

Optional | Date and time when the credit or debit is applied.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | direct\_deposit.**standard\_entry\_class\_code**

string

Optional | Three-letter code identifying the type of entry.

**Allowable Values:**

ACK, ADV, ARC, ATX, BOC, CCD, CIE, COR, CTX, DNE, ENR, IAT, MTE, POP, POS, PPD, RCK, SHR, TEL, TRC, TRX, WEB, XCK | | direct\_deposit.**state**

string

Optional | Current status of the direct deposit record.

**Allowable Values:**

PENDING, APPLIED, REVERSED, REJECTED | | direct\_deposit.**state\_reason**

string

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

**Allowable Values:**

255 char max | | direct\_deposit.**state\_reason\_code**

string

Optional | Standard code describing the reason for the current state.

**Allowable Values:**

See ACHR return reason codes for the full list of supported codes and the grace period associated with each. | | direct\_deposit.**token**

string

Optional | The unique identifier of the direct deposit record.

**Allowable Values:**

Existing direct deposit record token | | direct\_deposit.**type**

string

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

**Allowable Values:**

CREDIT, DEBIT | | direct\_deposit.**user\_token**

string

Optional | The unique identifier of the user account holder.

**Allowable Values:**

Existing user token | | dispute

object

Optional | Contains information about a disputed transaction.

**Allowable Values:**

Existing dispute object | | dispute.**case\_management\_identifier**

string

Optional | The unique identifier of the dispute case.

**Allowable Values:**

255 char max | | dispute.**reason**

string

Optional | The reason for the dispute.

**Allowable Values:**

255 char max | | duration

integer

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

**Allowable Values:**

Any integer | | enhanced\_data\_token

string

Optional | The enhanced commercial card data token for the transaction.

**Allowable Values:**

255 char max | | estimated\_authorization

boolean

Optional | Indicates an estimated authorization. An estimated authorization allows the merchant to obtain an approval for funds before the cardholder has finalized exactly what goods or services will be purchased.

**Allowable Values:**

true, false | | fee

object

Optional | Contains details about the fee.

**Allowable Values:**

amount, created\_time, currency\_code, last\_modified\_time, name, tags, token | | fee.**amount**

decimal

Required | Amount of the fee.

**Allowable Values:**

decimal

**Format:**
0.00 | | fee.**created\_time**

datetime

Required | Date and time when the fees object was created, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | fee.**currency\_code**

string

Required | Three-digit ISO 4217 currency code.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | fee.**last\_modified\_time**

datetime

Required | Date and time when the fees object was last modified, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | fee.**name**

string

Required | Name of the fee.

**Allowable Values:**

50 char max | | fee.**tags**

string

Optional | Descriptive metadata about the fee.

**Allowable Values:**

255 char max | | fee.**token**

string

Required | Unique identifier of the fees object.

**Allowable Values:**

Existing fees object token | | fee\_transfer

object

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

**Allowable Values:**

business\_token, created\_time, fees, tags, token, user\_token | | fee\_transfer.**business\_token**

string

Required | Specifies the business account holder to which the fee applies.

**Allowable Values:**

1–36 chars | | fee\_transfer.**created\_time**

datetime

Required | Date and time when the fee\_charge object was created, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | fee\_transfer.**fees**

array of objects

Required | Contains attributes that define characteristics of one or more fees.

**Allowable Values:**

Array of existing fees objects | | fee\_transfer.fees\[].**fee**

object

Required | Contains details about the fee.

**Allowable Values:**

amount, created\_time, currency\_code, last\_modified\_time, name, tags, token | | fee\_transfer.fees\[].fee.**amount**

decimal

Required | Amount of the fee.

**Allowable Values:**

decimal

**Format:**
0.00 | | fee\_transfer.fees\[].fee.**created\_time**

datetime

Required | Date and time when the fees object was created, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | fee\_transfer.fees\[].fee.**currency\_code**

string

Required | Three-digit ISO 4217 currency code.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | fee\_transfer.fees\[].fee.**last\_modified\_time**

datetime

Required | Date and time when the fees object was last modified, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | fee\_transfer.fees\[].fee.**name**

string

Required | Name of the fee.

**Allowable Values:**

50 char max | | fee\_transfer.fees\[].fee.**tags**

string

Optional | Descriptive metadata about the fee.

**Allowable Values:**

255 char max | | fee\_transfer.fees\[].fee.**token**

string

Required | Unique identifier of the fees object.

**Allowable Values:**

Existing fees object token | | fee\_transfer.fees\[].**memo**

string

Optional | Additional text describing the fee.

**Allowable Values:**

1–255 chars | | fee\_transfer.fees\[].**overrideAmount**

decimal

Optional | Dynamic fee amount that overrides the fee.amount field value.

**Allowable Values:**

decimal

**Format:**
0.00 | | fee\_transfer.fees\[].**tags**

string

Optional | Descriptive metadata about the fee.

**Allowable Values:**

255 char max | | fee\_transfer.fees\[].**token**

string

Required | Unique identifier of the fee.

**Allowable Values:**

1–36 chars | | fee\_transfer.fees\[].**transaction\_token**

string

Required | Unique identifier of the fee transaction.

**Allowable Values:**

36 char max | | fee\_transfer.**tags**

string

Optional | Metadata about the fee charge.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max | | fee\_transfer.**token**

string

Required | Unique identifier of the fee transfer.

**Allowable Values:**

1–36 chars | | fee\_transfer.**user\_token**

string

Required | Specifies the user account holder to which the fee applies.

**Allowable Values:**

1–36 chars | | fees

array of objects

Optional | List of fees associated with the transaction.

This array is returned if it exists in the resource.

**Allowable Values:**

Array of existing fees objects | | fees\[].**amount**

decimal

Optional | Amount of the network fee.

**Allowable Values:**

decimal

**Format:**
0.00 | | fees\[].**credit\_debit**

string

Optional | Indicates whether the fee is a credit or a debit.

- **C** indicates a credit
- **D** indicates a debit

**Allowable Values:**

C, D | | fees\[].**currency**

string

Optional | Type of currency used when assessing a CROSS\_BORDER\_ISSUER\_FEE or INTERCHANGE\_FEE on Mastercard multi-currency transactions. Three-digit ISO 4217 currency code.

**Allowable Values:**

Any currency code allowed by your program | | fees\[].**type**

string

Optional | Type of fee assessed by the card network.

**Allowable Values:**

ISSUER\_FEE, SWITCH\_FEE, PINDEBIT\_ASSOC\_FEE, ACQUIRER\_FEE, INTERCHANGE\_FEE, CUR\_CONV\_CARDHOLDER\_FEE, CUR\_CONV\_ISSUER\_FEE, CROSS\_BORDER\_ISSUER\_FEE | | fleet\_data

object

Optional | Contains details about fleet program transactions.

**Allowable Values:**

purchase\_type, prompt\_data | | fleet\_data.**purchase\_type**

string

Optional | If provided by the network, indicates whether the purchase contains items for fuel, non-fuel, or both.

**Allowable Values:**

fuel, non-fuel, fuel\_and\_non\_fuel | | fleet\_data.**prompt\_data**

object

Optional | If card product is configured for prompting, contains prompt data entered at the point of sale.

**Allowable Values:**

driver\_number, vehicle\_number, odometer | | fleet\_data.prompt\_data.**driver\_number**

string

Optional | Driver number entered at the point of sale.

**Allowable Values:**

255 char max | | fleet\_data.prompt\_data.**vehicle\_number**

string

Optional | Vehicle number entered at the point of sale.

**Allowable Values:**

255 char max | | fleet\_data.prompt\_data.**odometer**

string

Optional | Fleet vehicle odometer reading entered at the point of sale.

**Allowable Values:**

255 char max | | flex

object

Optional | Contains information about a Flexible Credential transaction.

**Allowable Values:**

action, eligible, eligible\_products, secondary\_credential\_identifier, selected\_product | | flex.**action**

string

Optional | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).

**Allowable Values:**

inquiry, advice | | flex.**eligible**

string

Optional | Indicates whether or not the transaction is eligible for Flexible Credential transactions.

**Allowable Values:**

true, false | | flex.**eligible\_products**

array of strings

Optional | Specifies which of the payment instrument’s credentials is eligible for this transaction:

- A value of DEBIT indicates the primary credential.
- A value of LOAN indicates the secondary credential.

**Allowable Values:**

DEBIT, LOAN | | flex.**secondary\_credential\_identifier**

string

Optional | Identifies the secondary credential used in the transaction, if applicable.

**Allowable Values:**

255 char max | | flex.**selected\_product**

string

Optional | Indicates the eligible product that was used in the transaction.

**Allowable Values:**

DEBIT, LOAN | | fraud

object

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

**Allowable Values:**

issuer\_processor, network\_fraud\_view, network\_account\_intelligence\_score | | fraud.**issuer\_processor**

object

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

**Allowable Values:**

recommended\_action, risk\_level, riskcontrol\_tags, rule\_violations, score | | fraud.issuer\_processor.**recommended\_action**

string

Optional | The action recommended based on the fraud score.

**Allowable Values:**

APPROVE, DECLINE, NOT\_PERFORMED | | fraud.issuer\_processor.**risk\_level**

string

Optional | The fraud rating, or level of risk associated with the transaction.

**Allowable Values:**

high, low | | fraud.issuer\_processor.**riskcontrol\_tags**

array of objects

Optional | The RiskControl tags that were triggered by the transaction.

**Allowable Values:**

rule\_name, tag. values | | fraud.issuer\_processor.riskcontrol\_tags\[].**rule\_name**

string

Optional | Name of the rule, as defined in the Real-Time Decisioning dashboard, that was triggered.

**Allowable Values:**

255 char max | | fraud.issuer\_processor.riskcontrol\_tags\[].**tag**

string

Optional | Tag name defined in the rule definition in the Real-Time Decisioning dashboard.

**Allowable Values:**

255 char max | | fraud.issuer\_processor.riskcontrol\_tags\[].**values**

array of strings

Optional | Value associated with the tag.

**Allowable Values:**

255 char max | | fraud.issuer\_processor.**rule\_violations**

array of strings

Optional | The rules violated by the transaction.

**Allowable Values:**

Valid array of rule\_violations strings | | fraud.issuer\_processor.**score**

integer

Optional | The risk score generated by RiskControl. This is either the Mastercard Decision Intelligence or Visa Advance Authorization transaction risk score.

**Allowable Values:**

0-99 | | fraud.issuer\_processor.**triggered\_rules**

array of objects

Optional | Provides a list of rules triggered by a fraud event, along with the information on tags and rule characteristics.

**Allowable Values:**

alert, entity\_type, rule\_name, suppress\_alert, tags | | fraud.issuer\_processor.triggered\_rules\[].**alert**

boolean

Optional | Indicates if the rule triggered an alert.

**Allowable Values:**

true, false | | fraud.issuer\_processor.triggered\_rules\[].**entity\_type**

string

Optional | The entity type where the triggered rule was defined.

**Allowable Values:**

Valid entity type | | fraud.issuer\_processor.triggered\_rules\[].**rule\_name**

string

Optional | Name of the rule, as defined in the Real-Time Decisioning dashboard that was triggered.

**Allowable Values:**

255 char max | | fraud.issuer\_processor.triggered\_rules\[].**suppress\_alert**

boolean

Optional | Indicates if the triggered rule has suppress\_alert in the definition.

**Allowable Values:**

true, false | | fraud.issuer\_processor.triggered\_rules\[].**tags**

array of objects

Optional | All the tags defined in the triggered rule.

**Allowable Values:**

name, value | | fraud.**network**

object

Optional | Contains network-provided information about fraud determinations.

**Allowable Values:**

account\_risk\_score, account\_risk\_score\_reason\_code, transaction\_risk\_score, transaction\_risk\_score\_reason\_code, transaction\_risk\_score\_reason\_description | | fraud.network.**account\_risk\_score**

string

Optional | *(Visa only)* Account holder risk condition code evaluated by the card network. A higher score indicates a greater likelihood that the card number is compromised.

**Allowable Values:**

1-9 | | fraud.network.**account\_risk\_score\_reason\_code**

string

Optional | *(Visa only)* Unique code that describes the main driver of the account\_risk\_score.

**Allowable Values:**

255 char max | | fraud.network.**card\_not\_present\_transaction\_risk\_score**

string

Optional | *(Visa only)* Visa-provided score ranking the risk of fraud for a card-not-present transaction. A higher score indicates higher risk. Useful for making authorization decisions.

**Allowable Values:**

Two-digit number between 01 and 99 | | fraud.network.**dii\_score**

string

Optional | Mastercard Digital Identity Insights risk score, where 0 indicates the lowest risk and 9 indicates the highest risk.

**Allowable Values:**

One-digit number between 0 and 9 | | fraud.network.**dii\_score\_reason\_code**

string

Optional | Mastercard Digital Identity Insights risk score reason code, where AA indicates the lowest risk, and ZZ indicates the highest risk.

**Allowable Values:**

Reason code, as provided by the Mastercard network | | fraud.network.**transaction\_account\_attack\_intelligence\_score**

string

Optional | *(Visa only)* Visa-provided score ranking the risk of an account enumeration attack in a card-not-present transaction. A higher score indicates higher risk. A score of 00 indicates insufficient data to determine risk. Useful for making authorization decisions.

**Allowable Values:**

Two-digit number between 00 and 99 | | fraud.network.**transaction\_risk\_score**

integer

Optional | Network-provided risk score for the transaction. A higher score indicates higher risk. Useful for making authorization decisions.

**Allowable Values:**

Mastercard: 0-99

Visa: 1-99

Pulse: 1-99 | | fraud.network.**transaction\_risk\_score\_reason\_code**

string

Optional | For Mastercard only. Unique code that describes the main driver of the transaction\_risk\_score.

**Allowable Values:**

1-29 | | fraud.network.**transaction\_risk\_score\_reason\_description**

string

Optional | For Mastercard only. Description of the transaction\_risk\_score\_reason\_code.

**Allowable Values:**

255 char max | | fraud.**network\_account\_intelligence\_score**

object

Optional | Account intelligence score information, as provided by the Mastercard network.

**Allowable Values:**

name, service\_type, value | | fraud.network\_account\_intelligence\_score.**name**

string

Optional | The name, as provided by the Mastercard network.

**Allowable Values:**

255 char max | | fraud.network\_account\_intelligence\_score.**service\_type**

string

Optional | The service type, as provided by the Mastercard network.

**Allowable Values:**

255 char max | | fraud.network\_account\_intelligence\_score.**value**

string

Optional | The value, as provided by the Mastercard network.

**Allowable Values:**

255 char max | | from\_account

string

Optional | Specifies the funding account type.

**Allowable Values:**

DEFAULT, OTHER, SAVINGS, CHECKING, CREDIT CARD, DEFERRED DEBIT, CHARGE, CREDIT LINE, CORPORATE, CREDIT FACILITY, UNIVERSAL, MONEY MARKET INVESTMENT, IRA INVESTMENT, EMPLOYEE BENEFIT, STORED VALUE, REVOLVING LOAN, MORTGAGE, INSTALLMENT LOAN ACCOUNT, REAL ESTATE LOAN, CHILD CARE BENEFIT, CASH BENEFIT, UNKNOWN, FOOD STAMP | | gpa

object

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

**Allowable Values:**

available\_balance, balances, cached\_balance, credit\_balance, currency\_code, impacted\_amount, last\_updated\_time, ledger\_balance, pending\_credits | | gpa.**available\_balance**

decimal

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

**Allowable Values:**

decimal

**Format:**
0.00 | | gpa.**balances**

object

Required | Contains GPA balance information, organized by currency code.

**Allowable Values:**

One or more balances objects | | gpa.**cached\_balance**

decimal

Required | Not currently in use.

**Allowable Values:**

Not applicable | | gpa.**credit\_balance**

decimal

Required | Not currently in use.

**Allowable Values:**

Not applicable | | gpa.**currency\_code**

string

Required | Three-digit ISO 4217 currency code.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | gpa.**impacted\_amount**

decimal

Optional | Balance change based on the amount of the transaction.

**Allowable Values:**

decimal

**Format:**
0.00 | | gpa.**last\_updated\_time**

datetime

Required | Date and time when the resource was last updated, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa.**ledger\_balance**

decimal

Required | When using standard funding: The funds that are available to spend immediately, including funds from any authorized transactions that have not yet cleared. When using Just-in-Time (JIT) Funding: Authorized funds that are currently on hold, but not yet cleared.

**Allowable Values:**

decimal

**Format:**
0.00 | | gpa.**pending\_credits**

decimal

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

**Allowable Values:**

decimal

**Format:**
0.00 | | gpa\_order

object

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

**Allowable Values:**

amount, business\_token, created\_time, currency\_code, fees, funding, funding\_source\_address\_token, funding\_source\_token, gateway\_message, gateway\_token, jit\_funding, last\_modified\_time, memo, response, state, tags, token, transaction\_token, user\_token | | gpa\_order.**amount**

decimal

Required | Amount funded.

**Allowable Values:**

decimal

**Format:**
0.00 | | gpa\_order.**business\_token**

string

Optional | Unique identifier of the business.

This field is returned if it exists in the resource.

**Allowable Values:**

Existing business\_token | | gpa\_order.**created\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order.**currency\_code**

string

Required | Three-digit ISO 4217 currency code.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | gpa\_order.**fees**

array of objects

Optional | List of fees associated with the funding transaction.

This array is returned if it exists in the resource.

**Allowable Values:**

Valid array of one or more fees objects | | gpa\_order.fees\[].**fee**

object

Required | Contains details about the fee.

**Allowable Values:**

amount, created\_time, currency\_code, last\_modified\_time, name, tags, token | | gpa\_order.fees\[].fee.**amount**

decimal

Required | Amount of the fee.

**Allowable Values:**

decimal

**Format:**
0.00 | | gpa\_order.fees\[].fee.**created\_time**

datetime

Required | Date and time when the fees object was created, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order.fees\[].fee.**currency\_code**

string

Required | Three-digit ISO 4217 currency code.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | gpa\_order.fees\[].fee.**last\_modified\_time**

datetime

Required | Date and time when the fees object was last modified, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order.fees\[].fee.**name**

string

Required | Name of the fee.

**Allowable Values:**

50 char max | | gpa\_order.fees\[].fee.**tags**

string

Optional | Descriptive metadata about the fee.

**Allowable Values:**

255 char max | | gpa\_order.fees\[].fee.**token**

string

Required | Unique identifier of the fees object.

**Allowable Values:**

Existing fees object token | | gpa\_order.fees\[].**memo**

string

Optional | Additional text describing the fee.

**Allowable Values:**

1–255 chars | | gpa\_order.fees\[].**overrideAmount**

decimal

Optional | Dynamic fee amount that overrides the fee.amount field value.

**Allowable Values:**

decimal

**Format:**
0.00 | | gpa\_order.fees\[].**tags**

string

Optional | Descriptive metadata about the fee.

**Allowable Values:**

255 char max | | gpa\_order.fees\[].**token**

string

Required | Unique identifier of the fee.

**Allowable Values:**

1–36 chars | | gpa\_order.fees\[].**transaction\_token**

string

Required | Unique identifier of the fee transaction.

**Allowable Values:**

36 char max | | gpa\_order.**funding**

object

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

**Allowable Values:**

amount, gateway\_log, source, source\_address | | gpa\_order.funding.**amount**

decimal

Optional | Amount of funds loaded into the GPA.

**Allowable Values:**

decimal

**Format:**
0.00 | | gpa\_order.funding.**gateway\_log**

object

Optional | Contains information from the JIT Funding gateway in response to a funding request.

**Allowable Values:**

duration, message, order\_number, response, timed\_out, transaction\_id | | gpa\_order.funding.gateway\_log.**duration**

integer

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

**Allowable Values:**

Any integer | | gpa\_order.funding.gateway\_log.**message**

string

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

**Allowable Values:**

Approved or completed successfully, Declined by gateway, Operation timeout | | gpa\_order.funding.gateway\_log.**order\_number**

string

Required | Customer order number, same value as transaction.token.

**Allowable Values:**

Existing transaction.token value | | gpa\_order.funding.gateway\_log.**response**

object

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

**Allowable Values:**

code, data | | gpa\_order.funding.gateway\_log.response.**code**

string

Required | Code received from the gateway.

**Allowable Values:**

255 char max | | gpa\_order.funding.gateway\_log.response.**data**

object

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

**Allowable Values:**

jit\_funding | | gpa\_order.funding.gateway\_log.response.data.**jit\_funding**

object

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

This object is returned if your program uses JIT Funding.

**Allowable Values:**

acting\_user\_token, address\_verification, amount, balances, business\_token, decline\_reason, incremental\_authorization\_jit\_funding\_tokens, memo, method, original\_jit\_funding\_token, tags, token, user\_token | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**acting\_user\_token**

string

Optional | User who conducted the transaction.

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

**Allowable Values:**

36 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**address\_verification**

object

Optional | Contains address verification data used to make JIT Funding decisions.

**Allowable Values:**

gateway, issuer, request | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.**gateway**

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, response | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.**issuer**

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, response | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.**request**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.request.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.request.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.address\_verification.request.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**jit\_account\_name\_verification**

object

Optional | Contains account name verification data used to make JIT Funding decisions from one of the following objects:

- The gateway object, which contains account name verification data from your JIT Funding gateway.
- The issuer object, which contains account name verification data from the Marqeta platform.
- The request object, which contains account name verification data as it appears in a JIT Funding request.

**Allowable Values:**

gateway, issuer, request | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.jit\_account\_name\_verification.**gateway**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.jit\_account\_name\_verification.**issuer**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.jit\_account\_name\_verification.**request**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**amount**

decimal

Required | Requested amount of funding.

**Allowable Values:**

0 min

**Format:**
0.00 | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**balances**

object

Optional | Contains the GPA’s balance details.

**Allowable Values:**

available\_balance, balances, cached\_balance, credit\_balance, currency\_code, impacted\_amount, last\_updated\_time, ledger\_balance, pending\_credits | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**business\_token**

string

Optional | Holder of the business account that was funded.

**Allowable Values:**

36 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**decline\_reason**

string

Optional | Reason why the transaction was declined.

**Allowable Values:**

AMOUNT\_LIMIT\_EXCEEDED, BLOCKED\_BY\_CARDHOLDER, BLOCKED\_BY\_ISSUER, BLOCKED\_MERCHANT\_BY\_CARDHOLDER, CARD\_NOT\_ACTIVE, CARDHOLDER\_NOT\_ACTIVE, CLOSED\_ACCOUNT, DUPLICATE\_TRANSACTION, EXPIRED\_CARD, INSUFFICIENT\_FUNDS, INVALID\_AMOUNT, INVALID\_CARD, INVALID\_MERCHANT, NO\_CHECKING\_ACCOUNT, NO\_CREDIT\_ACCOUNT, NO\_SAVINGS\_ACCOUNT, REVOCATION\_ALL\_AUTHORIZATION\_ORDER, REVOCATION\_AUTHORIZATION\_ORDER, SOFT\_DECLINE\_AUTHENTICATION\_REQUIRED, SOFT\_DECLINE\_PIN\_REQUIRED, STOP\_PAYMENT, SUSPECTED\_FRAUD, TRANSACTION\_COUNT\_LIMIT\_EXCEEDED, TRANSACTION\_NOT\_PERMITTED | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**incremental\_authorization\_jit\_funding\_tokens**

array of strings

Optional | Array of tokens referencing the JIT Funding tokens of all previous associated incremental authorization JIT Funding requests. Useful for ascertaining the final transaction amount when the original amount was incremented.

**Allowable Values:**

Existing incremental authorization JIT Funding tokens | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**memo**

string

Optional | Additional information that describes the JIT Funding transaction.

**Allowable Values:**

99 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**method**

string

Required | JIT Funding response type. See The jit\_funding object for the purpose, funding event type, and description of each method.

**Allowable Values:**

pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account\_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth\_plus\_capture, pgfs.auth\_plus\_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force\_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth\_plus\_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**original\_jit\_funding\_token**

string

Optional | Unique identifier of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages.

**Allowable Values:**

36 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**tags**

string

Optional | Customer-defined tags related to the JIT Funding transaction.

**Allowable Values:**

255 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**token**

string

Required | Existing JIT Funding token matching the funding.gateway\_log.transaction\_id field of the associated GPA order.

**NOTE:** The transaction\_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction\_id field matches the token of the most recent message.

**Allowable Values:**

36 char max | | gpa\_order.funding.gateway\_log.response.data.jit\_funding.**user\_token**

string

Required | Holder of the user account that was funded.

**Allowable Values:**

36 char max | | gpa\_order.funding.gateway\_log.response.data.**flex**

object

Optional | Contains information about a Flexible Credential transaction.

**Allowable Values:**

action, eligible, eligible\_products, secondary\_credential\_identifier, selected\_product | | gpa\_order.funding.gateway\_log.response.data.flex.**action**

string

Optional | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).

**Allowable Values:**

inquiry, advice | | gpa\_order.funding.gateway\_log.response.data.flex.**eligible**

string

Optional | Indicates whether or not the transaction is eligible for Flexible Credential transactions.

**Allowable Values:**

true, false | | gpa\_order.funding.gateway\_log.response.data.flex.**eligible\_products**

array of strings

Optional | Specifies which of the payment instrument’s credentials is eligible for this transaction:

- A value of DEBIT indicates the primary credential.
- A value of LOAN indicates the secondary credential.

**Allowable Values:**

DEBIT, LOAN | | gpa\_order.funding.gateway\_log.response.data.flex.**secondary\_credential\_identifier**

string

Optional | Identifies the secondary credential used in the transaction, if applicable.

**Allowable Values:**

255 char max | | gpa\_order.funding.gateway\_log.response.data.flex.**selected\_product**

string

Optional | Indicates the eligible product that was used in the transaction.

**Allowable Values:**

DEBIT, LOAN | | gpa\_order.funding.gateway\_log.**timed\_out**

boolean

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

**Allowable Values:**

true, false | | gpa\_order.funding.gateway\_log.**transaction\_id**

string

Required | Customer-defined identifier for the transaction.

**Allowable Values:**

255 char max | | gpa\_order.funding.**source**

object

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

**Allowable Values:**

active, created\_time, is\_default\_account, last\_modified\_time, token, type | | gpa\_order.funding.source.**active**

boolean

Required | Whether the funding source is active.

**Allowable Values:**

true, false | | gpa\_order.funding.source.**created\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order.funding.source.**is\_default\_account**

boolean

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

**Allowable Values:**

true, false | | gpa\_order.funding.source.**last\_modified\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order.funding.source.**token**

string

Required | Unique identifier of the funding source.

**Allowable Values:**

Format: UUID | | gpa\_order.funding.source.**type**

string

Required | Funding type of the funding source.

**Allowable Values:**

ach, paymentcard | | gpa\_order.funding.**source\_address**

object

Optional | Contains information about the billing address of the funding source.

**Allowable Values:**

active, address\_1, address\_2, business\_token, city, country, created\_time, first\_name, is\_default\_address, last\_modified\_time, last\_name, phone, postal\_code, state, token, user\_token, zip | | gpa\_order.funding.source\_address.**active**

boolean

Optional | Whether the address is active.

**Allowable Values:**

true, false | | gpa\_order.funding.source\_address.**address\_1**

string

Required | Street address of the funding source.

**Allowable Values:**

255 char max | | gpa\_order.funding.source\_address.**address\_2**

string

Optional | Additional address information for the funding source.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max | | gpa\_order.funding.source\_address.**business\_token**

string

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

This field is returned if it exists in the resource.

**Allowable Values:**

1–36 chars | | gpa\_order.funding.source\_address.**city**

string

Required | City of the funding source.

**Allowable Values:**

40 char max | | gpa\_order.funding.source\_address.**country**

string

Required | Country of the funding source.

**Allowable Values:**

1–40 chars | | gpa\_order.funding.source\_address.**created\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order.funding.source\_address.**first\_name**

string

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

**Allowable Values:**

40 char max | | gpa\_order.funding.source\_address.**is\_default\_address**

boolean

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

**Allowable Values:**

true, false | | gpa\_order.funding.source\_address.**last\_modified\_time**

datetime

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

This field is returned if it exists in the resource.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order.funding.source\_address.**last\_name**

string

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

**Allowable Values:**

40 char max | | gpa\_order.funding.source\_address.**phone**

string

Optional | Phone number of the funding source.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max | | gpa\_order.funding.source\_address.**postal\_code**

string

Required | Postal code of the funding source.

**Allowable Values:**

10 char max | | gpa\_order.funding.source\_address.**state**

string

Required | Two-character state, provincial, or territorial abbreviation.

For the complete list, see Valid state, provincial, territorial, and federal abbreviations.

**Allowable Values:**

2 char max | | gpa\_order.funding.source\_address.**token**

string

Required | Unique identifier of the funding\_source\_address object.

**Allowable Values:**

1–36 chars | | gpa\_order.funding.source\_address.**user\_token**

string

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

This field is returned if it exists in the resource.

**Allowable Values:**

1–36 chars | | gpa\_order.funding.source\_address.**zip**

string

Required | United States ZIP code of the funding source.

**Allowable Values:**

10 char max | | gpa\_order.**funding\_source\_address\_token**

string

Optional | Unique identifier of the funding source address to use for this order.

**Allowable Values:**

Existing funding\_source\_address token | | gpa\_order.**funding\_source\_token**

string

Required | Unique identifier of the funding source to use for this order.

**Allowable Values:**

Existing funding\_source token | | gpa\_order.**gateway\_message**

string

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

This field is returned if it exists in the resource.

**Allowable Values:**

Approved or completed successfully, Declined by gateway, Operation timeout | | gpa\_order.**gateway\_token**

integer

Optional | Unique identifier of the JIT Funding request and response.

This field is returned if it exists in the resource.

**Allowable Values:**

Existing gateway\_token | | gpa\_order.**jit\_funding**

object

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

This object is returned if your program uses JIT Funding.

**Allowable Values:**

acting\_user\_token, address\_verification, amount, balances, business\_token, decline\_reason, incremental\_authorization\_jit\_funding\_tokens, memo, method, original\_jit\_funding\_token, tags, token, user\_token | | gpa\_order.jit\_funding.**acting\_user\_token**

string

Optional | User who conducted the transaction.

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

**Allowable Values:**

36 char max | | gpa\_order.jit\_funding.**address\_verification**

object

Optional | Contains address verification data used to make JIT Funding decisions.

**Allowable Values:**

gateway, issuer, request | | gpa\_order.jit\_funding.address\_verification.**gateway**

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, response | | gpa\_order.jit\_funding.address\_verification.gateway.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order.jit\_funding.address\_verification.gateway.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order.jit\_funding.address\_verification.gateway.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order.jit\_funding.address\_verification.gateway.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order.jit\_funding.address\_verification.gateway.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | gpa\_order.jit\_funding.address\_verification.gateway.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | gpa\_order.jit\_funding.address\_verification.gateway.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | gpa\_order.jit\_funding.address\_verification.gateway.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | gpa\_order.jit\_funding.address\_verification.**issuer**

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, response | | gpa\_order.jit\_funding.address\_verification.issuer.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order.jit\_funding.address\_verification.issuer.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order.jit\_funding.address\_verification.issuer.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order.jit\_funding.address\_verification.issuer.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order.jit\_funding.address\_verification.issuer.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | gpa\_order.jit\_funding.address\_verification.issuer.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | gpa\_order.jit\_funding.address\_verification.issuer.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | gpa\_order.jit\_funding.address\_verification.issuer.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | gpa\_order.jit\_funding.address\_verification.**request**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order.jit\_funding.address\_verification.request.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order.jit\_funding.address\_verification.request.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order.jit\_funding.address\_verification.request.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order.jit\_funding.**jit\_account\_name\_verification**

object

Optional | Contains account name verification data used to make JIT Funding decisions from one of the following objects:

- The gateway object, which contains account name verification data from your JIT Funding gateway.
- The issuer object, which contains account name verification data from the Marqeta platform.
- The request object, which contains account name verification data as it appears in a JIT Funding request.

**Allowable Values:**

gateway, issuer, request | | gpa\_order.jit\_funding.jit\_account\_name\_verification.**gateway**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order.jit\_funding.jit\_account\_name\_verification.**issuer**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order.jit\_funding.jit\_account\_name\_verification.**request**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order.jit\_funding.**amount**

decimal

Required | Requested amount of funding.

**Allowable Values:**

0 min

**Format:**
0.00 | | gpa\_order.jit\_funding.**balances**

object

Optional | Contains the GPA’s balance details.

**Allowable Values:**

available\_balance, balances, cached\_balance, credit\_balance, currency\_code, impacted\_amount, last\_updated\_time, ledger\_balance, pending\_credits | | gpa\_order.jit\_funding.**business\_token**

string

Optional | Holder of the business account that was funded.

**Allowable Values:**

36 char max | | gpa\_order.jit\_funding.**decline\_reason**

string

Optional | Reason why the transaction was declined.

**Allowable Values:**

AMOUNT\_LIMIT\_EXCEEDED, BLOCKED\_BY\_CARDHOLDER, BLOCKED\_BY\_ISSUER, BLOCKED\_MERCHANT\_BY\_CARDHOLDER, CARD\_NOT\_ACTIVE, CARDHOLDER\_NOT\_ACTIVE, CLOSED\_ACCOUNT, DUPLICATE\_TRANSACTION, EXPIRED\_CARD, INSUFFICIENT\_FUNDS, INVALID\_AMOUNT, INVALID\_CARD, INVALID\_MERCHANT, NO\_CHECKING\_ACCOUNT, NO\_CREDIT\_ACCOUNT, NO\_SAVINGS\_ACCOUNT, REVOCATION\_ALL\_AUTHORIZATION\_ORDER, REVOCATION\_AUTHORIZATION\_ORDER, SOFT\_DECLINE\_AUTHENTICATION\_REQUIRED, SOFT\_DECLINE\_PIN\_REQUIRED, STOP\_PAYMENT, SUSPECTED\_FRAUD, TRANSACTION\_COUNT\_LIMIT\_EXCEEDED, TRANSACTION\_NOT\_PERMITTED | | gpa\_order.jit\_funding.**incremental\_authorization\_jit\_funding\_tokens**

array of strings

Optional | Array of tokens referencing the JIT Funding tokens of all previous associated incremental authorization JIT Funding requests. Useful for ascertaining the final transaction amount when the original amount was incremented.

**Allowable Values:**

Existing incremental authorization JIT Funding tokens | | gpa\_order.jit\_funding.**memo**

string

Optional | Additional information that describes the JIT Funding transaction.

**Allowable Values:**

99 char max | | gpa\_order.jit\_funding.**method**

string

Required | JIT Funding response type. See The jit\_funding object for the purpose, funding event type, and description of each method.

**Allowable Values:**

pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account\_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth\_plus\_capture, pgfs.auth\_plus\_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force\_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth\_plus\_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal | | gpa\_order.jit\_funding.**original\_jit\_funding\_token**

string

Optional | Unique identifier of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages.

**Allowable Values:**

36 char max | | gpa\_order.jit\_funding.**tags**

string

Optional | Customer-defined tags related to the JIT Funding transaction.

**Allowable Values:**

255 char max | | gpa\_order.jit\_funding.**token**

string

Required | Existing JIT Funding token matching the funding.gateway\_log.transaction\_id field of the associated GPA order.

**NOTE:** The transaction\_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction\_id field matches the token of the most recent message.

**Allowable Values:**

36 char max | | gpa\_order.jit\_funding.**user\_token**

string

Required | Holder of the user account that was funded.

**Allowable Values:**

36 char max | | gpa\_order.**last\_modified\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order.**memo**

string

Optional | Additional descriptive text.

This field is returned if it exists in the resource.

**Allowable Values:**

99 char max | | gpa\_order.**response**

object

Required | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | gpa\_order.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | gpa\_order.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | gpa\_order.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | gpa\_order.**state**

string

Required | Current status of the funding transaction.

**Allowable Values:**

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, REVERSED | | gpa\_order.**tags**

string

Optional | Comma-delimited list of tags describing the GPA order.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max | | gpa\_order.**token**

string

Required | Unique identifier of the GPA order.

**Allowable Values:**

36 char max | | gpa\_order.**transaction\_token**

string

Required | Unique identifier of the transaction being funded.

**Allowable Values:**

Format: UUID | | gpa\_order.**user\_token**

string

Optional | Unique identifier of the user resource.

This field is returned if it exists in the resource.

**Allowable Values:**

Existing user resource token | | gpa\_order\_unload

object

Optional | Contains information about a GPA unload order.

**Allowable Values:**

amount, created\_time, funding, funding\_source\_address\_token, funding\_source\_token, jit\_funding, last\_modified\_time, memo, original\_order\_token, response, state, tags, token, transaction\_token | | gpa\_order\_unload.**amount**

decimal

Required | Amount of funds returned to the funding source.

**Allowable Values:**

decimal

**Format:**
0.00 | | gpa\_order\_unload.**created\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order\_unload.**funding**

object

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

**Allowable Values:**

amount, gateway\_log, source, source\_address | | gpa\_order\_unload.funding.**amount**

decimal

Optional | Amount of funds loaded into the GPA.

**Allowable Values:**

decimal

**Format:**
0.00 | | gpa\_order\_unload.funding.**gateway\_log**

object

Optional | Contains information from the JIT Funding gateway in response to a funding request.

**Allowable Values:**

duration, message, order\_number, response, timed\_out, transaction\_id | | gpa\_order\_unload.funding.gateway\_log.**duration**

integer

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

**Allowable Values:**

Any integer | | gpa\_order\_unload.funding.gateway\_log.**message**

string

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

**Allowable Values:**

Approved or completed successfully, Declined by gateway, Operation timeout | | gpa\_order\_unload.funding.gateway\_log.**order\_number**

string

Required | Customer order number, same value as transaction.token.

**Allowable Values:**

Existing transaction.token value | | gpa\_order\_unload.funding.gateway\_log.**response**

object

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

**Allowable Values:**

code, data | | gpa\_order\_unload.funding.gateway\_log.response.**code**

string

Required | Code received from the gateway.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.gateway\_log.response.**data**

object

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

**Allowable Values:**

jit\_funding | | gpa\_order\_unload.funding.gateway\_log.response.data.**jit\_funding**

object

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

This object is returned if your program uses JIT Funding.

**Allowable Values:**

acting\_user\_token, address\_verification, amount, balances, business\_token, decline\_reason, incremental\_authorization\_jit\_funding\_tokens, memo, method, original\_jit\_funding\_token, tags, token, user\_token | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**acting\_user\_token**

string

Optional | User who conducted the transaction.

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

**Allowable Values:**

36 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**address\_verification**

object

Optional | Contains address verification data used to make JIT Funding decisions.

**Allowable Values:**

gateway, issuer, request | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.**gateway**

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, response | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.gateway.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.**issuer**

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, response | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.issuer.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.**request**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.request.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.request.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.address\_verification.request.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**jit\_account\_name\_verification**

object

Optional | Contains account name verification data used to make JIT Funding decisions from one of the following objects:

- The gateway object, which contains account name verification data from your JIT Funding gateway.
- The issuer object, which contains account name verification data from the Marqeta platform.
- The request object, which contains account name verification data as it appears in a JIT Funding request.

**Allowable Values:**

gateway, issuer, request | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.jit\_account\_name\_verification.**gateway**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.jit\_account\_name\_verification.**issuer**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.jit\_account\_name\_verification.**request**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**amount**

decimal

Required | Requested amount of funding.

**Allowable Values:**

0 min

**Format:**
0.00 | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**balances**

object

Optional | Contains the GPA’s balance details.

**Allowable Values:**

available\_balance, balances, cached\_balance, credit\_balance, currency\_code, impacted\_amount, last\_updated\_time, ledger\_balance, pending\_credits | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**business\_token**

string

Optional | Holder of the business account that was funded.

**Allowable Values:**

36 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**decline\_reason**

string

Optional | Reason why the transaction was declined.

**Allowable Values:**

AMOUNT\_LIMIT\_EXCEEDED, BLOCKED\_BY\_CARDHOLDER, BLOCKED\_BY\_ISSUER, BLOCKED\_MERCHANT\_BY\_CARDHOLDER, CARD\_NOT\_ACTIVE, CARDHOLDER\_NOT\_ACTIVE, CLOSED\_ACCOUNT, DUPLICATE\_TRANSACTION, EXPIRED\_CARD, INSUFFICIENT\_FUNDS, INVALID\_AMOUNT, INVALID\_CARD, INVALID\_MERCHANT, NO\_CHECKING\_ACCOUNT, NO\_CREDIT\_ACCOUNT, NO\_SAVINGS\_ACCOUNT, REVOCATION\_ALL\_AUTHORIZATION\_ORDER, REVOCATION\_AUTHORIZATION\_ORDER, SOFT\_DECLINE\_AUTHENTICATION\_REQUIRED, SOFT\_DECLINE\_PIN\_REQUIRED, STOP\_PAYMENT, SUSPECTED\_FRAUD, TRANSACTION\_COUNT\_LIMIT\_EXCEEDED, TRANSACTION\_NOT\_PERMITTED | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**incremental\_authorization\_jit\_funding\_tokens**

array of strings

Optional | Array of tokens referencing the JIT Funding tokens of all previous associated incremental authorization JIT Funding requests. Useful for ascertaining the final transaction amount when the original amount was incremented.

**Allowable Values:**

Existing incremental authorization JIT Funding tokens | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**memo**

string

Optional | Additional information that describes the JIT Funding transaction.

**Allowable Values:**

99 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**method**

string

Required | JIT Funding response type. See The jit\_funding object for the purpose, funding event type, and description of each method.

**Allowable Values:**

pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account\_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth\_plus\_capture, pgfs.auth\_plus\_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force\_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth\_plus\_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**original\_jit\_funding\_token**

string

Optional | Unique identifier of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages.

**Allowable Values:**

36 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**tags**

string

Optional | Customer-defined tags related to the JIT Funding transaction.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**token**

string

Required | Existing JIT Funding token matching the funding.gateway\_log.transaction\_id field of the associated GPA order.

**NOTE:** The transaction\_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction\_id field matches the token of the most recent message.

**Allowable Values:**

36 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.jit\_funding.**user\_token**

string

Required | Holder of the user account that was funded.

**Allowable Values:**

36 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.**flex**

object

Optional | Contains information about a Flexible Credential transaction.

**Allowable Values:**

action, eligible, eligible\_products, secondary\_credential\_identifier, selected\_product | | gpa\_order\_unload.funding.gateway\_log.response.data.flex.**action**

string

Optional | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).

**Allowable Values:**

inquiry, advice | | gpa\_order\_unload.funding.gateway\_log.response.data.flex.**eligible**

string

Optional | Indicates whether or not the transaction is eligible for Flexible Credential transactions.

**Allowable Values:**

true, false | | gpa\_order\_unload.funding.gateway\_log.response.data.flex.**eligible\_products**

array of strings

Optional | Specifies which of the payment instrument’s credentials is eligible for this transaction:

- A value of DEBIT indicates the primary credential.
- A value of LOAN indicates the secondary credential.

**Allowable Values:**

DEBIT, LOAN | | gpa\_order\_unload.funding.gateway\_log.response.data.flex.**secondary\_credential\_identifier**

string

Optional | Identifies the secondary credential used in the transaction, if applicable.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.gateway\_log.response.data.flex.**selected\_product**

string

Optional | Indicates the eligible product that was used in the transaction.

**Allowable Values:**

DEBIT, LOAN | | gpa\_order\_unload.funding.gateway\_log.**timed\_out**

boolean

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

**Allowable Values:**

true, false | | gpa\_order\_unload.funding.gateway\_log.**transaction\_id**

string

Required | Customer-defined identifier for the transaction.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.**source**

object

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

**Allowable Values:**

active, created\_time, is\_default\_account, last\_modified\_time, token, type | | gpa\_order\_unload.funding.source.**active**

boolean

Required | Whether the funding source is active.

**Allowable Values:**

true, false | | gpa\_order\_unload.funding.source.**created\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order\_unload.funding.source.**is\_default\_account**

boolean

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

**Allowable Values:**

true, false | | gpa\_order\_unload.funding.source.**last\_modified\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order\_unload.funding.source.**token**

string

Required | Unique identifier of the funding source.

**Allowable Values:**

Format: UUID | | gpa\_order\_unload.funding.source.**type**

string

Required | Funding type of the funding source.

**Allowable Values:**

ach, paymentcard | | gpa\_order\_unload.funding.**source\_address**

object

Optional | Contains information about the billing address of the funding source.

**Allowable Values:**

active, address\_1, address\_2, business\_token, city, country, created\_time, first\_name, is\_default\_address, last\_modified\_time, last\_name, phone, postal\_code, state, token, user\_token, zip | | gpa\_order\_unload.funding.source\_address.**active**

boolean

Optional | Whether the address is active.

**Allowable Values:**

true, false | | gpa\_order\_unload.funding.source\_address.**address\_1**

string

Required | Street address of the funding source.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.source\_address.**address\_2**

string

Optional | Additional address information for the funding source.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.source\_address.**business\_token**

string

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

This field is returned if it exists in the resource.

**Allowable Values:**

1–36 chars | | gpa\_order\_unload.funding.source\_address.**city**

string

Required | City of the funding source.

**Allowable Values:**

40 char max | | gpa\_order\_unload.funding.source\_address.**country**

string

Required | Country of the funding source.

**Allowable Values:**

1–40 chars | | gpa\_order\_unload.funding.source\_address.**created\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order\_unload.funding.source\_address.**first\_name**

string

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

**Allowable Values:**

40 char max | | gpa\_order\_unload.funding.source\_address.**is\_default\_address**

boolean

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

**Allowable Values:**

true, false | | gpa\_order\_unload.funding.source\_address.**last\_modified\_time**

datetime

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

This field is returned if it exists in the resource.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order\_unload.funding.source\_address.**last\_name**

string

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

**Allowable Values:**

40 char max | | gpa\_order\_unload.funding.source\_address.**phone**

string

Optional | Phone number of the funding source.

This field is returned if it exists in the resource.

**Allowable Values:**

255 char max | | gpa\_order\_unload.funding.source\_address.**postal\_code**

string

Required | Postal code of the funding source.

**Allowable Values:**

10 char max | | gpa\_order\_unload.funding.source\_address.**state**

string

Required | Two-character state, provincial, or territorial abbreviation.

For the complete list, see Valid state, provincial, territorial, and federal abbreviations.

**Allowable Values:**

2 char max | | gpa\_order\_unload.funding.source\_address.**token**

string

Required | Unique identifier of the funding\_source\_address object.

**Allowable Values:**

1–36 chars | | gpa\_order\_unload.funding.source\_address.**user\_token**

string

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

This field is returned if it exists in the resource.

**Allowable Values:**

1–36 chars | | gpa\_order\_unload.funding.source\_address.**zip**

string

Required | United States ZIP code of the funding source.

**Allowable Values:**

10 char max | | gpa\_order\_unload.**funding\_source\_address\_token**

string

Optional | Identifies the funding source used for this order.

**Allowable Values:**

Existing funding\_source\_address token. | | gpa\_order\_unload.**funding\_source\_token**

string

Required | Identifies the funding source used for this order.

**Allowable Values:**

Existing funding\_source token | | gpa\_order\_unload.**jit\_funding**

object

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

This object is returned if your program uses JIT Funding.

**Allowable Values:**

acting\_user\_token, address\_verification, amount, balances, business\_token, decline\_reason, incremental\_authorization\_jit\_funding\_tokens, memo, method, original\_jit\_funding\_token, tags, token, user\_token | | gpa\_order\_unload.jit\_funding.**acting\_user\_token**

string

Optional | User who conducted the transaction.

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

**Allowable Values:**

36 char max | | gpa\_order\_unload.jit\_funding.**address\_verification**

object

Optional | Contains address verification data used to make JIT Funding decisions.

**Allowable Values:**

gateway, issuer, request | | gpa\_order\_unload.jit\_funding.address\_verification.**gateway**

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, response | | gpa\_order\_unload.jit\_funding.address\_verification.gateway.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order\_unload.jit\_funding.address\_verification.gateway.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.jit\_funding.address\_verification.gateway.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order\_unload.jit\_funding.address\_verification.gateway.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.jit\_funding.address\_verification.gateway.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | gpa\_order\_unload.jit\_funding.address\_verification.gateway.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | gpa\_order\_unload.jit\_funding.address\_verification.gateway.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | gpa\_order\_unload.jit\_funding.address\_verification.gateway.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | gpa\_order\_unload.jit\_funding.address\_verification.**issuer**

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, response | | gpa\_order\_unload.jit\_funding.address\_verification.issuer.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order\_unload.jit\_funding.address\_verification.issuer.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.jit\_funding.address\_verification.issuer.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order\_unload.jit\_funding.address\_verification.issuer.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.jit\_funding.address\_verification.issuer.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | gpa\_order\_unload.jit\_funding.address\_verification.issuer.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | gpa\_order\_unload.jit\_funding.address\_verification.issuer.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | gpa\_order\_unload.jit\_funding.address\_verification.issuer.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | gpa\_order\_unload.jit\_funding.address\_verification.**request**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | gpa\_order\_unload.jit\_funding.address\_verification.request.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.jit\_funding.address\_verification.request.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | gpa\_order\_unload.jit\_funding.address\_verification.request.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | gpa\_order\_unload.jit\_funding.**jit\_account\_name\_verification**

object

Optional | Contains account name verification data used to make JIT Funding decisions from one of the following objects:

- The gateway object, which contains account name verification data from your JIT Funding gateway.
- The issuer object, which contains account name verification data from the Marqeta platform.
- The request object, which contains account name verification data as it appears in a JIT Funding request.

**Allowable Values:**

gateway, issuer, request | | gpa\_order\_unload.jit\_funding.jit\_account\_name\_verification.**gateway**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order\_unload.jit\_funding.jit\_account\_name\_verification.**issuer**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order\_unload.jit\_funding.jit\_account\_name\_verification.**request**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | gpa\_order\_unload.jit\_funding.**amount**

decimal

Required | Requested amount of funding.

**Allowable Values:**

0 min

**Format:**
0.00 | | gpa\_order\_unload.jit\_funding.**balances**

object

Optional | Contains the GPA’s balance details.

**Allowable Values:**

available\_balance, balances, cached\_balance, credit\_balance, currency\_code, impacted\_amount, last\_updated\_time, ledger\_balance, pending\_credits | | gpa\_order\_unload.jit\_funding.**business\_token**

string

Optional | Holder of the business account that was funded.

**Allowable Values:**

36 char max | | gpa\_order\_unload.jit\_funding.**decline\_reason**

string

Optional | Reason why the transaction was declined.

**Allowable Values:**

AMOUNT\_LIMIT\_EXCEEDED, BLOCKED\_BY\_CARDHOLDER, BLOCKED\_BY\_ISSUER, BLOCKED\_MERCHANT\_BY\_CARDHOLDER, CARD\_NOT\_ACTIVE, CARDHOLDER\_NOT\_ACTIVE, CLOSED\_ACCOUNT, DUPLICATE\_TRANSACTION, EXPIRED\_CARD, INSUFFICIENT\_FUNDS, INVALID\_AMOUNT, INVALID\_CARD, INVALID\_MERCHANT, NO\_CHECKING\_ACCOUNT, NO\_CREDIT\_ACCOUNT, NO\_SAVINGS\_ACCOUNT, REVOCATION\_ALL\_AUTHORIZATION\_ORDER, REVOCATION\_AUTHORIZATION\_ORDER, SOFT\_DECLINE\_AUTHENTICATION\_REQUIRED, SOFT\_DECLINE\_PIN\_REQUIRED, STOP\_PAYMENT, SUSPECTED\_FRAUD, TRANSACTION\_COUNT\_LIMIT\_EXCEEDED, TRANSACTION\_NOT\_PERMITTED | | gpa\_order\_unload.jit\_funding.**incremental\_authorization\_jit\_funding\_tokens**

array of strings

Optional | Array of tokens referencing the JIT Funding tokens of all previous associated incremental authorization JIT Funding requests. Useful for ascertaining the final transaction amount when the original amount was incremented.

**Allowable Values:**

Existing incremental authorization JIT Funding tokens | | gpa\_order\_unload.jit\_funding.**memo**

string

Optional | Additional information that describes the JIT Funding transaction.

**Allowable Values:**

99 char max | | gpa\_order\_unload.jit\_funding.**method**

string

Required | JIT Funding response type. See The jit\_funding object for the purpose, funding event type, and description of each method.

**Allowable Values:**

pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account\_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth\_plus\_capture, pgfs.auth\_plus\_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force\_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth\_plus\_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal | | gpa\_order\_unload.jit\_funding.**original\_jit\_funding\_token**

string

Optional | Unique identifier of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages.

**Allowable Values:**

36 char max | | gpa\_order\_unload.jit\_funding.**tags**

string

Optional | Customer-defined tags related to the JIT Funding transaction.

**Allowable Values:**

255 char max | | gpa\_order\_unload.jit\_funding.**token**

string

Required | Existing JIT Funding token matching the funding.gateway\_log.transaction\_id field of the associated GPA order.

**NOTE:** The transaction\_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction\_id field matches the token of the most recent message.

**Allowable Values:**

36 char max | | gpa\_order\_unload.jit\_funding.**user\_token**

string

Required | Holder of the user account that was funded.

**Allowable Values:**

36 char max | | gpa\_order\_unload.**last\_modified\_time**

datetime

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

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | gpa\_order\_unload.**memo**

string

Optional | Additional descriptive text.

**Allowable Values:**

99 char max | | gpa\_order\_unload.**original\_order\_token**

string

Optional | Identifies the original GPA order.

**Allowable Values:**

Existing GPA order token | | gpa\_order\_unload.**response**

object

Required | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | gpa\_order\_unload.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | gpa\_order\_unload.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | gpa\_order\_unload.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | gpa\_order\_unload.**state**

string

Required | Current status of the GPA unload order.

**Allowable Values:**

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, REVERSED | | gpa\_order\_unload.**tags**

string

Optional | Comma-delimited list of tags describing the GPA order.

**Allowable Values:**

255 char max | | gpa\_order\_unload.**token**

string

Required | Unique identifier of the GPA unload order.

**Allowable Values:**

Existing GPA unload order token | | gpa\_order\_unload.**transaction\_token**

string

Required | Unique identifier of the transaction.

**Allowable Values:**

Format: UUID | | identifier

string

Required | Sequential identifier of the transaction.

**Allowable Values:**

255 char max | | incremental\_authorization\_transaction\_tokens

array of strings

Optional | An array of incremental authorization transaction tokens.

**Allowable Values:**

One or more transaction tokens | | is\_final\_clearing

boolean

Optional | Indicates the final clearing event for an authorization. If the final cleared amount is lower than the authorized amount, you must release the hold on the funds per the value in the amount\_to\_be\_released field.

**Allowable Values:**

true, false | | installment\_data

object

Optional | Contains the installment plan identifier used by the Visa Transaction Matching Service for Issuers.

**Allowable Values:**

installment\_plan\_identifier | | installment\_data.**installment\_plan\_identifier**

string

Optional | (*Visa only*) Visa Transaction Matching Service for Issuers identifier. This identifier matches a transaction on the Marqeta platform to an installment plan or Pay by Points transaction on the Visa card network.

**Allowable Values:**

10-character identifier, as provided by the Visa network | | is\_preauthorization

boolean

Optional | Indicates if the transaction is a pre-authorization.

**Allowable Values:**

true, false | | isaIndicator

string

Optional | The international service assessment indicator indicates if an ISA fee is applicable to the transaction.

**Allowable Values:**

MULTI\_CURRENCY, SINGLE\_CURRENCY, REBATE\_CANCELLED, MULTI\_CURRENCY\_NON\_US\_COUNTRIES, SINGLE\_CURRENCY\_PAID\_BY\_ISSUER, NO\_CHARGE\_ASSESSED | | issuer\_interchange\_amount

decimal

Optional | The amount of interchange charged by the card issuer.

**Allowable Values:**

decimal

**Format:**
0.00 | | issuer\_payment\_node

string

Optional | Unique identifier of the Marqeta platform server that received the transaction from the card network.

**Allowable Values:**

255 char max | | issuer\_received\_time

string

Optional | Date and time when the Marqeta platform received the transaction from the card network, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | local\_transaction\_date

datetime

Optional | Indicates the local time of the transaction at the card acceptor’s location. You can use this field to determine the correct time of the transaction when filing a dispute.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ | | merchant\_initiated\_original\_trace\_id

string

Optional | Unique network identification value formed by combining the 6- to 9-character Mastercard Banknet Reference Number and the 4-digit settlement date for recurring payments and other merchant-initiated transactions.

**Allowable Values:**

255 char max

**Example Value:**
MCC123ABC1105 | | multi\_clearing\_sequence\_count

string

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

**Allowable Values:**

The sequence count returned in the clearing record | | multi\_clearing\_sequence\_number

string

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

**Allowable Values:**

The sequence number returned in the clearing record | | network

string

Optional | Indicates which card network was used to complete the transactions.

**Allowable Values:**

DISCOVER, MASTERCARD, PULSE, VISA, MARQETA | | network\_metadata

object

Optional | Contains network-related metadata for the transaction, including details about the card program and the card product. Returned if provided by the card network

**Allowable Values:**

product\_id, program\_id, spend\_qualifier, surcharge\_free\_atm\_network | | network\_metadata.**product\_id**

string

Optional | Product identification value assigned by the card network to each card product. Can be used to track card-level activity by individual account number for premium card products.

**Allowable Values:**

AMERICAN\_EXPRESS, DINERS, DISCOVER, FLEXIBLE\_RATE\_B2B\_VIRTUAL\_PROGRAM, JCB, MASTERCARD, PRIVATE\_LABEL, PRIVATE\_LABEL\_BASIC, PRIVATE\_LABEL\_ENHANCED, PRIVATE\_LABEL\_PREMIUM, PRIVATE\_LABEL\_SPECIALIZED, PRIVATE\_LABEL\_STANDARD, PROPRIETARY, PROPRIETARY\_ATM, V\_PAY, VISA\_B2B\_VIRTUAL\_PAYMENTS VISA\_BUSINESS, VISA\_BUSINESS\_ENHANCED/VISA\_PLATINUM\_BUSINESS, VISA\_BUSINESS\_REWARDS, VISA\_CLASSIC, VISA\_COMMERCIAL\_AGRICULTURE, VISA\_COMMERCIAL\_MARKETPLACE, VISA\_COMMERCIAL\_TRANSPORT, VISA\_CORPORATE\_T\&E, VISA\_ELECTRON, VISA\_FLEXIBLE\_CREDENTIAL, VISA\_GOLD, VISA\_GOVERNMENT\_CORPORATE\_T\&E, VISA\_GOVERNMENT\_PURCHASING, VISA\_GOVERNMENT\_PURCHASING\_WITH\_FLEET, VISA\_HEALTHCARE, VISA\_INFINITE, VISA\_INFINITE\_BUSINESS, VISA\_INFINITE\_PRIVILEGE, VISA\_PLATINUM, VISA\_PURCHASING, VISA\_PURCHASING\_WITH\_FLEET/VISA\_FLEET\_(CANADA\_ONLY), VISA\_REWARDS, VISA\_SELECT, VISA\_SIGNATURE, VISA\_SIGNATURE\_BUSINESS, VISA\_SIGNATURE\_PREFERRED, VISA\_TRADITIONAL, VISA\_TRADITIONAL\_REWARDS, VISA\_TRAVELMONEY, VISA\_ULTRA\_HIGH\_NET\_WORTH\_(UHNW) | | network\_metadata.**incoming\_response\_code**

string

Optional | Network response code, as provided by the card network.

For example, Visa response code 59 indicates suspected fraud.

**Allowable Values:**

Response code, as provided by the card network | | network\_metadata.**outgoing\_response\_code**

string

Optional | Network response code, as provided by Marqeta.
For example, Visa response code 59 indicates suspected fraud.

**Allowable Values:**

Valid response code, as defined by the card network | | network\_metadata.**program\_id**

string

Optional | Program identification number used with product\_id that identifies the programs associated with a card within a program registered by the issuer with the card network.

**Allowable Values:**

255 char max | | network\_metadata.**spend\_qualifier**

string

Optional | Indicates whether or not the base spend-assessment threshold defined by the card network has been met.

**Allowable Values:**

255 char max | | network\_metadata.**surcharge\_free\_atm\_network**

string

Optional | Name of the surcharge-free ATM network used to complete the transaction.

**Allowable Values:**

AllPoint, MoneyPass, MoneyPass Pulse Select | | network\_metadata.**network\_funding\_txn\_type**

string

Optional | Transaction type indicator provided by the card network for original credit and account funding transactions.

**Allowable Values:**

Literal value provided by the card network | | network\_reference\_id

string

Optional | Network-assigned unique identifier of the transaction. Useful for settlement and reconciliation.

**Allowable Values:**

255 char max | | network\_transaction\_lifecycle\_id

string

Optional | Transaction identifier, as provided by the card network. This identifier connects the original transaction to all subsequent activities throughout the transaction lifecycle.

**Allowable Values:**

255 char max | | original\_credit

object

Optional | Contains information about an original credit transaction (OCT), which enables the cardholder to receive funds on the specified card from an external source via the card network.

**Allowable Values:**

Existing original\_credit object | | original\_credit.**funding\_source**

string

Optional | Sender’s account from which the OCT draws funds.

**Allowable Values:**

CREDIT, DEBIT, PREPAID, DEPOSIT\_ACCOUNT, CASH, MOBILE\_MONEY\_ACCOUNT, NON\_VISA\_CREDIT | | original\_credit.**screening\_score**

string

Optional | Sanctions screening score to assist with meeting Anti-Money Laundering (AML) obligations.

Higher scores indicate that the sender’s data more closely resembles an entry on the regulatory watchlist.

A value of 999 means that no screening score is available.

**Allowable Values:**

000-100 or 999 | | original\_credit.**sender\_account\_type**

string

Optional | The type of account from which the OCT draws funds.

**Allowable Values:**

OTHER, RTN\_BANK\_ACCOUNT, IBAN, CARD\_ACCOUNT, EMAIL, PHONE\_NUMBER, BANK\_ACCOUNT\_NUMBER\_AND\_BANK\_IDENTIFICATION\_CODE, WALLET\_ID, SOCIAL\_NETWORK\_ID | | original\_credit.**sender\_address**

string

Optional | Sender’s street address.

**Allowable Values:**

255 char max | | original\_credit.**sender\_city**

string

Optional | Sender’s city.

**Allowable Values:**

255 char max | | original\_credit.**sender\_country**

string

Optional | Sender’s country.

**Allowable Values:**

255 char max | | original\_credit.**sender\_name**

string

Optional | Full name of the sender.

**Allowable Values:**

255 char max | | original\_credit.**sender\_state**

string

Optional | Sender’s state.

**Allowable Values:**

255 char max | | original\_credit.**fast\_funds\_enabled**

boolean

Optional | Indicates that Fast Funds are enabled for dual-message original credit transactions. If the value of this field is true, you must make the funds available to your cardholder within 30 minutes of the transaction.

**Allowable Values:**

true, false

**Default value:**
false | | original\_credit.**transaction\_purpose**

string

Optional | The purpose of the original credit transaction.

**Allowable Values:**

FAMILY\_SUPPORT, REGULAR\_LABOR\_TRANSFERS, TRAVEL\_AND\_TOURISM, EDUCATION, MEDICAL\_TREATMENT, EMERGENCY\_NEED, SAVINGS, GIFTS, OTHER, SALARY, CROWD\_LENDING, CRYPTO\_CURRENCY, HIGH\_RISK\_SECURITIES, RECYCLING\_DEPOSIT\_RETURN, VALUE\_ADDED\_TAX\_PAYMENT, TRANSFER\_TO\_ANOTHER\_PERSON\_OR\_ORGANIZATION\_IN\_THE\_SAME\_STAGED\_DIGITAL\_WALLET, BOLETO\_PAYMENT | | original\_credit.**transaction\_type**

string

Optional | Type of original credit transaction.

**Allowable Values:**

ACCOUNT\_TO\_ACCOUNT, PERSON\_TO\_PERSON, WALLET\_TRANSFER, MONEY\_TRANSFER\_BY\_BANK, BUSINESS\_TO\_BUSINESS, DISBURSEMENT, GOVERNMENT\_DISBURSEMENT, GAMBLING\_PAYOUT, LOYALTY, MERCHANT\_DISBURSEMENT, ONLINE\_GAMBLING\_PAYOUT, PENSION\_DISBURSEMENT, PREPAID\_LOADS, CARD\_BILL\_PAYMENT, BILL\_PAYMENT, CASH\_CLAIM, CASH\_IN, CASH\_OUT, MOBILE\_AIR\_TIME\_PAYMENT, MONEY\_TRANSFER\_BY\_MERCHANT, FACE\_TO\_FACE\_MERCHANT\_PAYMENT, GOVERNMENT\_PAYMENT, PAYMENTS\_GOODS\_SERVICES, FUNDS\_TRANSFER, GENERAL\_BUSINESS\_TO\_BUSINESS\_TRANSFER, BUSINESS\_TO\_BUSINESS\_TRANSFER, CASH\_DEPOSIT | | original\_transaction\_token

string

Optional | Unique identifier of the original transaction in a series of related transactions.

**Allowable Values:**

Existing transaction token | | payment\_facilitator

object

Optional | Information about the payment facilitator of an account funding or original credit transaction.

**Allowable Values:**

city, country\_code, postal\_code, state, street\_address | | payment\_facilitator.**city**

string

Optional | Payment facilitator’s city.

**Allowable Values:**

255 char max | | payment\_facilitator.**country\_code**

string

Optional | Payment facilitator’s country code.

**Allowable Values:**

Valid three-digit ISO 3166 country code | | payment\_facilitator.**postal\_code**

string

Optional | Payment facilitator’s postal code.

**Allowable Values:**

255 char max | | payment\_facilitator.**state**

string

Optional | Payment facilitator’s state location.

**Allowable Values:**

255 char max | | payment\_facilitator.**street\_address**

string

Optional | Payment facilitator’s street address.

**Allowable Values:**

255 char max | | peer\_transfer

object

Optional | Contains information about an intra-account transfer, including sender and recipient tokens, transfer amount, and currency code.

**Allowable Values:**

amount, currency\_code, memo, recipient\_business\_token, recipient\_user\_token, sender\_business\_token, sender\_user\_token, tags, token | | peer\_transfer.**amount**

decimal

Required | Amount of the transfer.

**Allowable Values:**

decimal

**Format:**
0.00 | | peer\_transfer.**currency\_code**

string

Required | Three-digit ISO 4217 currency code.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | peer\_transfer.**memo**

string

Optional | Additional descriptive text about the intra-account transfer.

**Allowable Values:**

1–99 chars | | peer\_transfer.**recipient\_business\_token**

string

Optional | Specifies the business account holder that receives funds.

**Allowable Values:**

1–36 chars | | peer\_transfer.**recipient\_user\_token**

string

Optional | Specifies the user account holder that receives funds.

**Allowable Values:**

1–36 chars | | peer\_transfer.**sender\_business\_token**

string

Optional | Specifies the business account holder that sends funds.

**Allowable Values:**

1–36 chars | | peer\_transfer.**sender\_user\_token**

string

Optional | Specifies the user account holder that sends funds.

**Allowable Values:**

1–36 chars | | peer\_transfer.**tags**

string

Optional | Metadata about the intra-account transfer.

**Allowable Values:**

1–255 chars | | peer\_transfer.**token**

string

Required | Unique identifier of the intra-account transfer request.

**Allowable Values:**

1–36 chars | | polarity

string

Optional | Indicates whether the transaction is credit or debit.

**Allowable Values:**

CREDIT, DEBIT, PENDING\_CREDIT, PENDING\_DEBIT | | pos

object

Optional | Contains information about the point of sale, including details on how the card was presented.

Returned if provided by the card network, and the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests.

**Allowable Values:**

Existing pos object | | pos.**card\_data\_input\_capability**

string

Optional | How the terminal accepts card data.

**Allowable Values:**

UNKNOWN, NO\_TERMINAL, MAG\_STRIPE, MAG\_STRIPE\_CONTACTLESS, MAG\_STRIPE\_KEY\_ENTRY, CHIP, CHIP\_CONTACTLESS, CHIP\_MAG\_STRIPE, CHIP\_MAG\_STRIPE\_KEY\_ENTRY, KEY\_ENTRY, OCR, MICR, BAR\_CODE | | pos.**card\_holder\_presence**

boolean

Optional | Whether the cardholder was present during the transaction.

**Allowable Values:**

true, false | | pos.**card\_presence**

boolean

Optional | Whether the card was present during the transaction.

**Allowable Values:**

true, false | | pos.**cardholder\_authentication\_method**

string

Optional | Method used to authenticate the cardholder.

**Allowable Values:**

UNSPECIFIED, NON\_AUTHENTICATED, SIGNATURE, PIN, ID\_VERIFIED | | pos.**country\_code**

string

Optional | Country code of the card acceptor or terminal.

**Allowable Values:**

Valid 3-digit ISO 3166 country code | | pos.**county**

string

Optional | County of the card acceptor or terminal.

**Allowable Values:**

255 char max | | pos.**is\_installment**

boolean

Optional | Whether the transaction is an installment payment.

**Allowable Values:**

true, false | | pos.**is\_recurring**

boolean

Optional | Whether the transaction is recurring.

**Allowable Values:**

true, false | | pos.**pan\_entry\_mode**

string

Optional | Method used for capturing the card primary account number (PAN) during the transaction.

**Allowable Values:**

UNKNOWN, MANUAL, MAG\_STRIPE, MAG\_STRIPE\_CONTACTLESS, BAR\_CODE, OCR, MICR, CHIP, CHIP\_CONTACTLESS, CARD\_ON\_FILE, CHIP\_FALLBACK, OTHER | | pos.**partial\_approval\_capable**

boolean

Optional | Indicates whether the card acceptor or terminal supports partial-approval transactions.

**Allowable Values:**

true, false | | pos.**pin\_entry\_mode**

string

Optional | Indicates whether the card acceptor or terminal can capture card personal identification numbers (PINs).

**NOTE:** This field does not indicate whether a PIN was entered.

**Allowable Values:**

UNKNOWN, TRUE, FALSE, DEFECTIVE | | pos.**pin\_present**

boolean

Optional | Indicates whether the cardholder entered a PIN during the transaction.

**Allowable Values:**

true, false | | pos.**purchase\_amount\_only**

boolean

Optional | Indicates whether the card acceptor or terminal supports purchase-only approvals.

**Allowable Values:**

true, false | | pos.**special\_condition\_indicator**

string

Optional | Indicates a higher-risk operation, such as a quasi-cash or cryptocurrency transaction.

These transactions typically involve non-financial institutions.

**Allowable Values:**

CRYPTOCURRENCY\_PURCHASE, DEBT\_PAYMENT, QUASI\_CASH, CENTRAL\_BANK\_DIGITAL\_CURRENCY\_PURCHASE, STABLECOIN\_PURCHASE, BLOCKCHAIN\_NATIVE\_TOKEN\_PURCHASE, NON\_FUNGIBLE\_TOKEN\_PURCHASE, UNSPECIFIED | | pos.**state**

string

Optional | State, province, or territory of the card acceptor or terminal.

**Allowable Values:**

255 char max | | pos.**terminal\_attendance**

string

Optional | Whether the card acceptor/terminal was attended.

**Allowable Values:**

UNSPECIFIED, ATTENDED, UNATTENDED, NO\_TERMINAL | | pos.**terminal\_id**

string

Optional | Card acceptor or terminal identification number.

**Allowable Values:**

255 char max | | pos.**terminal\_location**

string

Optional | Location of the card acceptor/terminal.

**Allowable Values:**

ON\_PREMISE, OFF\_PREMISE\_MERCHANT, OFF\_PREMISE\_CARDHOLDER, NO\_TERMINAL | | pos.**terminal\_type**

string

Optional | Type of card acceptor/terminal.

**Allowable Values:**

AUTO\_DISPENSER\_WITH\_PIN, SELF\_SERVICE, LIMITED\_AMOUNT, IN\_FLIGHT, ECOMMERCE, TRANSPONDER | | pos.**transaction\_initiated\_by**

string

Optional | Specifies the initiator of the transaction.

**Allowable Values:**

CONSUMER, MERCHANT, UNKNOWN | | pos.**transaction\_initiated\_category**

string

Optional | Specifies the category of a point-of-sale transaction.

**Allowable Values:**

CARD\_ON\_FILE, RECURRING\_VAR\_AMT\_FIXED\_FREQ, RECURRING\_PAYMENT, INSTALLMENT\_PAYMENT, UNSCHEDULED\_PAYMENT, PARTIAL\_SHIPMENT, DELAYED\_PAYMENT, NO\_SHOW, RESUBMISSION, DEFERRED\_BILLING, ACCOUNT\_INQUIRY, INCREMENTAL\_AUTHORIZATION, REAUTHORIZATION | | pos.**zip**

string

Optional | United States ZIP code of the card acceptor or terminal.

**Allowable Values:**

10 char max | | preceding\_related\_transaction\_token

string

Optional | Returned for final transaction types.

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

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

**Allowable Values:**

UUID | | preceding\_transaction

object

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

Contains information about the preceding transaction.

**Allowable Values:**

Existing preceding\_transaction object | | preceding\_transaction.**amount**

decimal

Optional | Amount of the preceding transaction.

**Allowable Values:**

decimal

**Format:**
0.00 | | preceding\_transaction.**token**

string

Optional | Unique identifier of the preceding transaction.

**Allowable Values:**

Existing transaction token | | program

object

Optional | Information about the program on the Marqeta platform.

**Allowable Values:**

Existing program object | | program.**long\_code**

string

Required | The program long code on the Marqeta platform.

**Allowable Values:**

255 char max | | program.**program\_id**

string

Required | The program identifier on the Marqeta platform.

**Allowable Values:**

255 char max | | program.**short\_code**

string

Required | The program short code on the Marqeta platform.

**Allowable Values:**

255 char max | | program\_transfer

object

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

**Allowable Values:**

amount, business\_token, created\_time, currency\_code, fees, jit\_funding, memo, tags, token, transaction\_token, type\_token, user\_token | | program\_transfer.**amount**

decimal

Required | Amount of program transfer.

**Allowable Values:**

decimal

**Format:**
0.00 | | program\_transfer.**business\_token**

string

Optional | Unique identifier of the business account holder. Returned if user\_token is not specified.

**Allowable Values:**

1–36 chars | | program\_transfer.**created\_time**

datetime

Optional | Date and time when the program transfer object was created, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | program\_transfer.**currency\_code**

string

Required | Three-digit ISO 4217 currency code.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | program\_transfer.**fees**

array of objects

Optional | Contains attributes that define characteristics of one or more fees.

**Allowable Values:**

Valid array of one or more fees objects | | program\_transfer.fees\[].**fee**

object

Required | Contains details about the fee.

**Allowable Values:**

amount, created\_time, currency\_code, last\_modified\_time, name, tags, token | | program\_transfer.fees\[].fee.**amount**

decimal

Required | Amount of the fee.

**Allowable Values:**

decimal

**Format:**
0.00 | | program\_transfer.fees\[].fee.**created\_time**

datetime

Required | Date and time when the fees object was created, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | program\_transfer.fees\[].fee.**currency\_code**

string

Required | Three-digit ISO 4217 currency code.

**Allowable Values:**

Valid three-digit ISO 4217 currency code | | program\_transfer.fees\[].fee.**last\_modified\_time**

datetime

Required | Date and time when the fees object was last modified, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | program\_transfer.fees\[].fee.**name**

string

Required | Name of the fee.

**Allowable Values:**

50 char max | | program\_transfer.fees\[].fee.**tags**

string

Optional | Descriptive metadata about the fee.

**Allowable Values:**

255 char max | | program\_transfer.fees\[].fee.**token**

string

Required | Unique identifier of the fees object.

**Allowable Values:**

Existing fees object token | | program\_transfer.fees\[].**memo**

string

Optional | Additional text describing the fee.

**Allowable Values:**

1–255 chars | | program\_transfer.fees\[].**overrideAmount**

decimal

Optional | Dynamic fee amount that overrides the fee.amount field value.

**Allowable Values:**

decimal

**Format:**
0.00 | | program\_transfer.fees\[].**tags**

string

Optional | Descriptive metadata about the fee.

**Allowable Values:**

255 char max | | program\_transfer.fees\[].**token**

string

Required | Unique identifier of the fee.

**Allowable Values:**

1–36 chars | | program\_transfer.fees\[].**transaction\_token**

string

Required | Unique identifier of the fee transaction.

**Allowable Values:**

36 char max | | program\_transfer.**jit\_funding**

object

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

This object is returned if your program uses JIT Funding.

**Allowable Values:**

acting\_user\_token, address\_verification, amount, balances, business\_token, decline\_reason, incremental\_authorization\_jit\_funding\_tokens, memo, method, original\_jit\_funding\_token, tags, token, user\_token | | program\_transfer.jit\_funding.**acting\_user\_token**

string

Optional | User who conducted the transaction.

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

**Allowable Values:**

36 char max | | program\_transfer.jit\_funding.**address\_verification**

object

Optional | Contains address verification data used to make JIT Funding decisions.

**Allowable Values:**

gateway, issuer, request | | program\_transfer.jit\_funding.address\_verification.**gateway**

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, response | | program\_transfer.jit\_funding.address\_verification.gateway.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | program\_transfer.jit\_funding.address\_verification.gateway.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | program\_transfer.jit\_funding.address\_verification.gateway.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | program\_transfer.jit\_funding.address\_verification.gateway.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | program\_transfer.jit\_funding.address\_verification.gateway.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | program\_transfer.jit\_funding.address\_verification.gateway.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | program\_transfer.jit\_funding.address\_verification.gateway.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | program\_transfer.jit\_funding.address\_verification.gateway.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | program\_transfer.jit\_funding.address\_verification.**issuer**

object

Optional | Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

**Allowable Values:**

on\_file, response | | program\_transfer.jit\_funding.address\_verification.issuer.**on\_file**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | program\_transfer.jit\_funding.address\_verification.issuer.on\_file.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | program\_transfer.jit\_funding.address\_verification.issuer.on\_file.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | program\_transfer.jit\_funding.address\_verification.issuer.on\_file.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | program\_transfer.jit\_funding.address\_verification.issuer.**response**

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | program\_transfer.jit\_funding.address\_verification.issuer.response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | program\_transfer.jit\_funding.address\_verification.issuer.response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | program\_transfer.jit\_funding.address\_verification.issuer.response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | program\_transfer.jit\_funding.address\_verification.**request**

object

Optional | Contains address verification information.

**Allowable Values:**

postal\_code, street\_address, zip | | program\_transfer.jit\_funding.address\_verification.request.**postal\_code**

string

Optional | Postal code of the address.

**Allowable Values:**

10 char max | | program\_transfer.jit\_funding.address\_verification.request.**street\_address**

string

Optional | Street name and number of the address.

**Allowable Values:**

40 char max | | program\_transfer.jit\_funding.address\_verification.request.**zip**

string

Optional | United States ZIP code of the address.

**Allowable Values:**

10 char max | | program\_transfer.jit\_funding.**jit\_account\_name\_verification**

object

Optional | Contains account name verification data used to make JIT Funding decisions from one of the following objects:

- The gateway object, which contains account name verification data from your JIT Funding gateway.
- The issuer object, which contains account name verification data from the Marqeta platform.
- The request object, which contains account name verification data as it appears in a JIT Funding request.

**Allowable Values:**

gateway, issuer, request | | program\_transfer.jit\_funding.jit\_account\_name\_verification.**gateway**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | program\_transfer.jit\_funding.jit\_account\_name\_verification.**issuer**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | program\_transfer.jit\_funding.jit\_account\_name\_verification.**request**

object

Optional | Contains account name verification data used to make JIT Funding decisions.

**Allowable Values:**

first\_name, last\_name, middle\_name | | program\_transfer.jit\_funding.**amount**

decimal

Required | Requested amount of funding.

**Allowable Values:**

0 min

**Format:**
0.00 | | program\_transfer.jit\_funding.**balances**

object

Optional | Contains the GPA’s balance details.

**Allowable Values:**

available\_balance, balances, cached\_balance, credit\_balance, currency\_code, impacted\_amount, last\_updated\_time, ledger\_balance, pending\_credits | | program\_transfer.jit\_funding.**business\_token**

string

Optional | Holder of the business account that was funded.

**Allowable Values:**

36 char max | | program\_transfer.jit\_funding.**decline\_reason**

string

Optional | Reason why the transaction was declined.

**Allowable Values:**

AMOUNT\_LIMIT\_EXCEEDED, BLOCKED\_BY\_CARDHOLDER, BLOCKED\_BY\_ISSUER, BLOCKED\_MERCHANT\_BY\_CARDHOLDER, CARD\_NOT\_ACTIVE, CARDHOLDER\_NOT\_ACTIVE, CLOSED\_ACCOUNT, DUPLICATE\_TRANSACTION, EXPIRED\_CARD, INSUFFICIENT\_FUNDS, INVALID\_AMOUNT, INVALID\_CARD, INVALID\_MERCHANT, NO\_CHECKING\_ACCOUNT, NO\_CREDIT\_ACCOUNT, NO\_SAVINGS\_ACCOUNT, REVOCATION\_ALL\_AUTHORIZATION\_ORDER, REVOCATION\_AUTHORIZATION\_ORDER, SOFT\_DECLINE\_AUTHENTICATION\_REQUIRED, SOFT\_DECLINE\_PIN\_REQUIRED, STOP\_PAYMENT, SUSPECTED\_FRAUD, TRANSACTION\_COUNT\_LIMIT\_EXCEEDED, TRANSACTION\_NOT\_PERMITTED | | program\_transfer.jit\_funding.**incremental\_authorization\_jit\_funding\_tokens**

array of strings

Optional | Array of tokens referencing the JIT Funding tokens of all previous associated incremental authorization JIT Funding requests. Useful for ascertaining the final transaction amount when the original amount was incremented.

**Allowable Values:**

Existing incremental authorization JIT Funding tokens | | program\_transfer.jit\_funding.**memo**

string

Optional | Additional information that describes the JIT Funding transaction.

**Allowable Values:**

99 char max | | program\_transfer.jit\_funding.**method**

string

Required | JIT Funding response type. See The jit\_funding object for the purpose, funding event type, and description of each method.

**Allowable Values:**

pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account\_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth\_plus\_capture, pgfs.auth\_plus\_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force\_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth\_plus\_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal | | program\_transfer.jit\_funding.**original\_jit\_funding\_token**

string

Optional | Unique identifier of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages.

**Allowable Values:**

36 char max | | program\_transfer.jit\_funding.**tags**

string

Optional | Customer-defined tags related to the JIT Funding transaction.

**Allowable Values:**

255 char max | | program\_transfer.jit\_funding.**token**

string

Required | Existing JIT Funding token matching the funding.gateway\_log.transaction\_id field of the associated GPA order.

**NOTE:** The transaction\_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction\_id field matches the token of the most recent message.

**Allowable Values:**

36 char max | | program\_transfer.jit\_funding.**user\_token**

string

Required | Holder of the user account that was funded.

**Allowable Values:**

36 char max | | program\_transfer.**memo**

string

Optional | Additional description of the program transfer.

**Allowable Values:**

1–99 chars | | program\_transfer.**tags**

string

Optional | Comma-delimited list of tags describing the program transfer.

**Allowable Values:**

1–255 chars | | program\_transfer.**token**

string

Optional | Unique identifier of the program transfer.

**Allowable Values:**

1–36 chars | | program\_transfer.**transaction\_token**

string

Required | Unique identifier of the transaction.

**Allowable Values:**

Existing transaction token | | program\_transfer.**type\_token**

string

Required | Unique identifier of the program transfer type.

**Allowable Values:**

1–36 chars | | program\_transfer.**user\_token**

string

Optional | Unique identifier of the user account holder. Returned if business\_token is not specified.

**Allowable Values:**

1–36 chars | | real\_time\_fee\_group

object

Optional | Contains information about a real-time fee group.

**Allowable Values:**

active, created\_time, fee\_tokens, last\_modified\_time, name, token | | real\_time\_fee\_group.**active**

boolean

Required | Indicates whether the real-time fee group is active.

**Allowable Values:**

true, false | | real\_time\_fee\_group.**created\_time**

datetime

Optional | Date and time when the real-time fee group was created, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | real\_time\_fee\_group.**fee\_tokens**

array of strings

Optional | Specifies the fees in this real-time fee group.

**Allowable Values:**

Array of existing fee tokens | | real\_time\_fee\_group.**last\_modified\_time**

datetime

Optional | Date and time when the real-time fee group was last modified, in UTC.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | real\_time\_fee\_group.**name**

string

Required | Descriptive name for the real-time fee group.

**Allowable Values:**

50 char max | | real\_time\_fee\_group.**token**

string

Required | Unique identifier of the real-time fee group.

**Allowable Values:**

36 char max | | request\_amount

decimal

Optional | Merchant-requested amount, including any fees.

**Allowable Values:**

decimal

**Format:**
0.00 | | response

object

Optional | Response codes and memos for account name verification, address verification, card security verification, and transactions.

**Allowable Values:**

additional\_information, code, memo | | response.**additional\_information**

string

Optional | Additional information about the transaction, such as velocity control details.

This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects.

**Allowable Values:**

255 char max | | response.**code**

string

Required | Four-digit response code for address verification, card security code verification, or transactions.

For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder.

- 0 indicates no validation was performed
- 1 indicates the match was unsuccessful (not matched)
- 2 indicates the match was partial
- 3 indicates the match was exact

For example:

Code / First Name / Middle Name / Last Name / Full Name
0000 / Not validated / Not validated / Not validated / Not validated
1111 / Not matched / Not matched / Not matched / Not matched
3333 / Exact match / Exact match / Exact match / Exact match
1232 / Not matched / Partial match / Exact match / Partial match

For address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder:

Code / Address / Postal Code
0000 / Match / Match
0001 / Match / Not matched
0100 / Not matched / Match
0101 / Not matched / Not matched
0200 / Data not present / Match
0201 / Data not present / Not matched
0002 / Match / Data not present
0102 / Not matched / Data not present
0303 / Not validated / Not validated

For card security verification, the code indicates whether the verification check passed and can have these possible values:

- 0000 – Passed
- 0001 – Did not pass

For a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes.

**Allowable Values:**

Four-digit code | | response.**memo**

string

Required | Additional text that describes the response.

**Allowable Values:**

255 char max | | settlement\_date

datetime

Optional | Date and time when funds were moved for a transaction, in UTC. For example, in the case of a refund, when funds were credited to the cardholder.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | settlement\_indicator

string

Optional | Indicates the settlement service used for the transaction.

**Allowable Values:**

INTERNATIONAL\_SETTLEMENT\_SERVICE, NATIONAL\_NET\_SETTLEMENT\_SERVICE, CLEARING\_ONLY, VISA\_SELECTS\_SETTLEMENT\_SERVICE | | standin\_approved\_by

string

Optional | Indicates which party approved a transaction: the card network using stand-in processing, or Marqeta using Commando Mode. Returned only when a transaction is approved.

**Allowable Values:**

NETWORK, COMMANDO\_AUTO, COMMANDO\_MANUAL | | standin\_by

string

Optional | Indicates which party approved a transaction: the card network using stand-in processing, or Marqeta using Commando Mode.

**Allowable Values:**

NETWORK, COMMANDO\_AUTO, COMMANDO\_MANUAL | | standin\_reason

string

Optional | Indicates why the card network handled a transaction requiring stand-in processing.

**Allowable Values:**

255 char max | | state

string

Required | Current state of the transaction. For more information about the state field, see The transaction lifecycle.

**Allowable Values:**

PENDING, CLEARED, COMPLETION, DECLINED, ERROR | | subnetwork

string

Optional | Indicates which subnetwork was used to complete the transaction. Possible values include the following:

- **VISANET** – Used for VisaNet signature-based transactions.
- **VISANETDEBIT** – Used for VisaNet Debit PIN-based transaction.
- **VISAINTERLINK** – Used for Visa Interlink PIN-based transactions.
- **VISAPLUS** – Used for ATM withdrawals on Visa.
- **MAESTRO** – Used for PIN-based transactions on Mastercard.
- **CIRRUS** – Used for ATM withdrawals on Mastercard.
- **MASTERCARDDEBIT** – Used for signature-based transactions on Mastercard.
- **GATEWAY\_JIT** – Used for Gateway JIT Funding transactions.
- **MANAGED\_JIT** – Used for Managed JIT Funding transactions or for transactions that occur while Commando Mode is enabled.

**Allowable Values:**

VISANET, VISANETDEBIT, VISAINTERLINK, VISAPLUS, MAESTRO, CIRRUS, MASTERCARDDEBIT, GATEWAY\_JIT, MANAGED\_JIT | | to\_account

string

Optional | Specifies the receiving account type.

**Allowable Values:**

DEFAULT, OTHER, SAVINGS, CHECKING, CREDIT CARD, DEFERRED DEBIT, CHARGE, CREDIT LINE, CORPORATE, CREDIT FACILITY, UNIVERSAL, MONEY MARKET INVESTMENT, IRA INVESTMENT, EMPLOYEE BENEFIT, STORED VALUE, REVOLVING LOAN, MORTGAGE, INSTALLMENT LOAN ACCOUNT, REAL ESTATE LOAN, CHILD CARE BENEFIT, CASH BENEFIT, UNKNOWN, FOOD STAMP | | token

string

Required | Unique identifier of the transaction, formatted as a UUID.

**NOTE:** For subsequent related transactions, this token value appears as the preceding\_related\_transaction\_token.

**Allowable Values:**

1–36 chars | | transaction\_attributes

object

Optional | Additional transaction attributes.

**Allowable Values:**

255 char max | | transaction\_metadata

object

Optional | Contains merchant-provided metadata related to the transaction, including details about lodging- and transit-related purchases.

May be returned if the request uses Transaction Model v2 of the Marqeta Core API. Not returned for Transaction Model v1 requests.

**Allowable Values:**

Existing transaction\_metadata object | | transaction\_metadata.**airline**

object

Optional | Contains information about airline-related transactions.

**Allowable Values:**

Existing airline object | | transaction\_metadata.airline.**depart\_date**

datetime

Optional | The date and time of departure.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | transaction\_metadata.airline.**origination\_city**

string

Optional | The city where the flight originates.

**Allowable Values:**

255 char max | | transaction\_metadata.airline.**passenger\_name**

string

Optional | The name of the passenger.

**Allowable Values:**

255 char max | | transaction\_metadata.**authorization\_life\_cycle**

integer

Optional | Number of days the pre-authorization is in effect.

**Allowable Values:**

Any integer | | transaction\_metadata.**cross\_border\_transaction**

boolean

Optional | Whether the transaction is cross-border, i.e., when the merchant and the cardholder are located in two different countries.

**Allowable Values:**

true, false | | transaction\_metadata.**is\_deferred\_authorization**

boolean

Optional | Indicates an offline authorization made during an interruption of card network connectivity, such as a purchase on a flight.

**Allowable Values:**

true, false | | transaction\_metadata.**is\_lodging\_auto\_rental**

boolean

Optional | Whether the transaction is a lodging or vehicle rental.

**Allowable Values:**

true, false | | transaction\_metadata.**lodging\_auto\_rental\_start\_date**

datetime

Optional | Date and time when the lodging check-in or vehicle rental began.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ | | transaction\_metadata.**memo**

string

Optional | Indicates a credit or debit adjustment in a clearing transaction.

**Allowable Values:**

CREDIT\_ADJUSTMENT, DEBIT\_ADJUSTMENT | | transaction\_metadata.**moto\_indicator**

string

Optional | Indicates the type of mail or telephone order transaction.

**Allowable Values:**

UNKNOWN, MANUAL, RECURRING, INSTALLMENT, OTHERS | | transaction\_metadata.**payment\_channel**

string

Optional | Channel from which the transaction was originated.

**Allowable Values:**

OTHER, ATM, ECOMMERCE, MAIL, PHONE, MOTO | | transaction\_metadata.**transaction\_category**

string

Optional | Type of product or service being purchased, if provided by the merchant.

**Allowable Values:**

RETAIL\_SALE, BILL\_PAY, HOTEL, HEALTH\_CARE, RESTAURANT, AUTO\_RENTAL, AIRLINE, PAYMENT, HOSPITALIZATION\_COLLEGE, PHONE\_MAIL\_ECOMMERCE, ATM, TRANSIT, EXTENDED\_AUTHORIZATION | | transaction\_metadata.**transit**

object

Optional | Contains merchant-provided, transit-related metadata related to the transaction.

**Allowable Values:**

Existing transit object | | transaction\_metadata.transit.**transaction\_type**

string

Optional | Type of transit transaction.

**Allowable Values:**

PRE\_FUNDED, REAL\_TIME\_AUTHORIZED, POST\_AUTHORIZED\_AGGREGATED, AUTHORIZED\_AGGREGATED\_SPLIT\_CLEARING, DEBIT\_RECOVERY, OTHER | | transaction\_metadata.transit.**transportation\_mode**

string

Optional | Mode of transportation.

**Allowable Values:**

BUS, TRAIN, WATER\_BORNE\_VEHICLE, TOLL, PARKING, TAXI, PARA\_TRANSIT, SELF\_DRIVE\_VEHICLE, COACH, LOCOMOTIVE, POWERED\_MOTOR\_VEHICLE, TRAILER, INTER\_CITY, CABLE\_CAR | | type

string

Required | Transaction event type. For more information about the type field, see Transaction events.

**Allowable Values:**

account.credit, account.debit, account.funding.authorization, account.funding.authorization.reversal, account.funding.authorization.clearing, accountfunding.pull, accountfunding.pull.chargeback, accountfunding.pull.chargeback.rev, authorization, authorization.advice, authorization.atm.withdrawal, authorization.cashback, authorization.clearing, authorization.clearing.atm.withdrawal, authorization.clearing.cashback, authorization.clearing.chargeback, authorization.clearing.chargeback.completed, authorization.clearing.chargeback.provisional.credit, authorization.clearing.chargeback.provisional.debit, authorization.clearing.chargeback.reversal, authorization.clearing.chargeback.writeoff, authorization.clearing.quasi.cash, authorization.incremental, authorization.pin.change, authorization.pin.unblock, authorization.quasi.cash, authorization.reversal, authorization.reversal.issuerexpiration, authorization.standin, balanceinquiry, directdeposit.credit, directdeposit.credit.pending, directdeposit.credit.pending.reversal, directdeposit.credit.reject, directdeposit.credit.reversal, directdeposit.debit, directdeposit.debit.pending, directdeposit.debit.pending.reversal, directdeposit.debit.reject, directdeposit.debit.reversal, dispute.credit, dispute.debit, fee.charge, fee.charge.pending, fee.charge.pending.refund, fee.charge.reversal, funds.expire, gpa.credit, gpa.credit.authorization, gpa.credit.authorization.billpayment, gpa.credit.authorization.billpayment.reversal, gpa.credit.authorization.reversal, gpa.credit.billpayment, gpa.credit.chargeback, gpa.credit.chargeback.reversal, gpa.credit.issueroperator, gpa.credit.pending, gpa.credit.pending.reversal, gpa.credit.reversal, gpa.credit.networkload, gpa.credit.networkload.reversal, gpa.debit, gpa.debit.issueroperator, gpa.debit.networkload, gpa.debit.pending, gpa.debit.pending.reversal, gpa.debit.reversal, gpa.grant, original.credit.authorization, original.credit.authorization.clearing, original.credit.authorization.reversal, original.credit.auth\_plus\_capture, original.credit.auth\_plus\_capture.reversal, pin.change.reversal, pin.change.reversal.advice, pindebit, pindebit.atm.withdrawal, pindebit.authorization, pindebit.authorization.clearing, pindebit.authorization.reversal, pindebit.authorization.reversal.issuerexpiration, pindebit.balanceinquiry, pindebit.cashback, pindebit.chargeback, pindebit.chargeback.completed, pindebit.chargeback.provisional.credit, pindebit.chargeback.provisional.debit, pindebit.chargeback.reversal, pindebit.chargeback.writeoff, pindebit.credit.adjustment, pindebit.pin.change, pindebit.pin.unblock, pindebit.quasicash, pindebit.refund, pindebit.refund.reversal, pindebit.reversal, pindebit.transfer, product.inquiry, programreserve.credit, programreserve.debit, pullfromcard.pull, pullfromcard.pull.chargeback, pullfromcard.pull.chargeback.rev, pullfromcard.pull.reversal, pushtocard.debit, pushtocard.reversal, refund, refund.authorization, refund.authorization.advice, refund.authorization.clearing, refund.authorization.reversal, reward.earn, token.activation-request, token.advice, transfer.fee, transfer.peer, transfer.program, transit.offer, unknown | | user

object

Optional | Contains customer-provided information about the cardholder that performed the transaction.

**Allowable Values:**

Existing cardholder\_metadata object | | user.**metadata**

object

Optional | Associates customer-provided metadata with the cardholder.

**Allowable Values:**

Up to 20 name-value pair fields in "field\_name\_1": "field\_value\_1" format. | | user\_token

string

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

**Allowable Values:**

36 char max | | user\_transaction\_time

datetime

Optional | Date and time when the user initiated the transaction, in UTC. For example, when a merchant performed the original authorization for a refund.

**Allowable Values:**

datetime

**Format:**
yyyy-MM-ddThh:mm:ssZ |

List transactions

**Action:** `GET` **Endpoint:** `/transactions` List all transactions. By default, this endpoint returns transactions conducted within the last 30 days. To return transactions older than 30 days, you must include the `start_date` and `end_date` query parameters in your request. By default, `GET /transactions` returns transactions having either `PENDING` or `COMPLETION` states. This endpoint supports [field filtering](/core-api/field-filtering/) and [pagination](/core-api/sorting-and-pagination/).

URL query parameters

| Fields | Description | | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | count

integer

Optional | The number of transactions to retrieve.

**Allowable Values:**

1-100 | | start\_index

integer

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

**Allowable Values:**

Any integer | | fields

string

Optional | Comma-delimited list of fields to return (field\_1,field\_2, and so on). Leave blank to return all fields.

**Allowable Values:**

Comma-delimited list of fields, or blank | | sort\_by

string

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

**Allowable Values:**

-created\_time, created\_time, -user\_transaction\_time, user\_transaction\_time | | start\_date

string

Optional | The starting date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the start\_date and end\_date fields.

**Allowable Values:**

Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS | | end\_date

string

Optional | The ending date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the end\_date and start\_date fields.

**Allowable Values:**

Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS | | type

string

Optional | Comma-delimited list of transaction types to include.

**Allowable Values:**

- account.credit
- account.debit
- account.funding.authorization
- account.funding.authorization.reversal
- account.funding.authorization.clearing
- accountfunding.pull
- accountfunding.pull.chargeback
- accountfunding.pull.chargeback.rev
- authorization
- authorization.advice
- authorization.atm.withdrawal
- authorization.cashback
- authorization.clearing
- authorization.clearing.atm.withdrawal
- authorization.clearing.cashback
- authorization.clearing.chargeback
- authorization.clearing.chargeback.completed
- authorization.clearing.chargeback.provisional.credit
- authorization.clearing.chargeback.provisional.debit
- authorization.clearing.chargeback.reversal
- authorization.clearing.chargeback.writeoff
- authorization.clearing.quasi.cash
- authorization.incremental
- authorization.quasi.cash
- authorization.reversal
- authorization.reversal.issuerexpiration
- authorization.standin
- balanceinquiry
- directdeposit.credit
- directdeposit.credit.pending
- directdeposit.credit.pending.reversal
- directdeposit.credit.reject
- directdeposit.credit.reversal
- directdeposit.debit
- directdeposit.debit.pending
- directdeposit.debit.pending.reversal
- directdeposit.debit.reject
- directdeposit.debit.reversal
- dispute.credit
- dispute.debit
- fee.charge
- fee.charge.pending
- fee.charge.pending.refund
- fee.charge.reversal
- funds.expire
- gpa.credit
- gpa.credit.authorization
- gpa.credit.authorization.billpayment
- gpa.credit.authorization.billpayment.reversal
- gpa.credit.authorization.reversal
- gpa.credit.billpayment
- gpa.credit.chargeback
- gpa.credit.chargeback.reversal
- gpa.credit.issueroperator
- gpa.credit.pending
- gpa.credit.pending.reversal
- gpa.credit.reversal
- gpa.credit.networkload
- gpa.credit.networkload.reversal
- gpa.debit
- gpa.debit.issueroperator
- gpa.debit.networkload
- gpa.debit.pending
- gpa.debit.pending.reversal
- gpa.debit.reversal
- gpa.grant
- original.credit.authorization
- original.credit.authorization.clearing
- original.credit.authorization.reversal
- original.credit.auth\_plus\_capture
- original.credit.auth\_plus\_capture.reversal
- pindebit
- pindebit.atm.withdrawal
- pindebit.authorization
- pindebit.authorization.clearing
- pindebit.authorization.reversal
- pindebit.authorization.reversal.issuerexpiration
- pindebit.balanceinquiry
- pindebit.cashback
- pindebit.chargeback
- pindebit.chargeback.completed
- pindebit.chargeback.provisional.credit
- pindebit.chargeback.provisional.debit
- pindebit.chargeback.reversal
- pindebit.chargeback.writeoff
- pindebit.credit.adjustment
- pindebit.quasicash
- pindebit.refund
- pindebit.refund.reversal
- pindebit.reversal
- pindebit.transfer
- product.inquiry
- programreserve.credit
- programreserve.debit
- pullfromcard.pull
- pullfromcard.pull.chargeback
- pullfromcard.pull.chargeback.rev
- pullfromcard.pull.reversal
- pushtocard.debit
- pushtocard.reversal
- refund
- refund.authorization
- refund.authorization.advice
- refund.authorization.clearing
- refund.authorization.reversal
- reward.earn
- token.activation-request
- token.advice
- transfer.fee
- transfer.peer
- transfer.program
- transit.offer
- unknown | | user\_token

string

Optional | The unique identifier of the user account holder.

**Allowable Values:**

Existing user token | | business\_token

string

Optional | The unique identifier of the business account holder.

**Allowable Values:**

Existing business token | | acting\_user\_token

string

Optional | The unique identifier of the acting user.

**Allowable Values:**

Existing user token | | card\_token

string

Optional | The unique identifier of the card.

**Allowable Values:**

Existing card token | | state

string

Optional | Comma-delimited list of transaction states to display.

**Allowable Values:**

PENDING, CLEARED, COMPLETION, DECLINED, ERROR | | version

string

Optional | Specifies the API version for the request.

**Allowable Values:**

v1, v2, v3 |

Response body

| Fields | Description | | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | count

integer

Conditionally returned | The number of resources to retrieve.

This field is returned if there are resources in your returned array.

**Allowable Values:**

1-10 | | data

array of objects

Conditionally returned | An array of transaction objects. See the Transaction object description at the top of this page.

Objects are returned as appropriate to your query.

**Allowable Values:**

Valid array of one or more transaction objects | | end\_index

integer

Conditionally returned | The sort order index of the last resource in the returned array.

This field is returned if there are resources in your returned array.

**Allowable Values:**

Any integer | | is\_more

boolean

Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.

This field is returned if there are resources in your returned array.

**Allowable Values:**

true, false | | start\_index

integer

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

This field is returned if there are resources in your returned array.

**Allowable Values:**

Any integer |

Sample response body

```json JSON expandable lines wrap theme={null} { "count": 2, "start_index": 0, "end_index": 1, "is_more": true, "data": [ { "type": "gpa.credit.authorization", "state": "PENDING", "token": "cd22cff7-2845-4508-a916-cf89fd9edae1", "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "card_token": "02cc766c-24a5-4c3b-adcf-0e5e27b09329", "preceding_related_transaction_token": "06a8fe88-58b1-4682-a8ad-96eb973e1d74", "gpa": { "currency_code": "USD", "ledger_balance": 20, "available_balance": 0, "credit_balance": 0, "pending_credits": 0, "impacted_amount": 10, "balances": { "USD": { "currency_code": "USD", "ledger_balance": 20, "available_balance": 0, "credit_balance": 0, "pending_credits": 0, "impacted_amount": 10 } } }, "gpa_order": { "token": "592b8164-a4af-45ee-ab24-13a4bb43e6b2", "amount": 10, "created_time": "2024-08-21T17:26:30Z", "last_modified_time": "2024-08-21T17:26:30Z", "transaction_token": "cd22cff7-2845-4508-a916-cf89fd9edae1", "state": "PENDING", "response": { "code": "0000", "memo": "Approved or completed successfully" }, "funding": { "amount": 10, "source": { "type": "programgateway", "token": "**********dd5f", "active": true, "name": "PGFS for simulating transactions", "is_default_account": false, "created_time": "2024-08-21T17:25:43Z", "last_modified_time": "2024-08-21T17:25:43Z" }, "gateway_log": { "order_number": "1200", "transaction_id": "your-jit-funding-token", "message": "Approved or completed successfully", "duration": 481, "timed_out": false, "response": { "code": "200", "data": { "jit_funding": { "token": "your-jit-funding-token", "method": "pgfs.authorization", "user_token": "your-jit-funding-user", "amount": 10, "original_jit_funding_token": "your-jit-funding-token", "address_verification": { "gateway": { "on_file": { "street_address": "2000 High St", "postal_code": "94601" }, "response": { "code": "0000", "memo": "Address and postal code match" } } } } } } } }, "funding_source_token": "**********dd5f", "jit_funding": { "token": "251bdc52-588a-4291-8c5d-6ded3a67e1a8", "method": "pgfs.authorization", "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "amount": 10 }, "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "currency_code": "USD" }, "duration": 537, "created_time": "2024-08-21T17:26:29Z", "issuer_received_time": "2024-08-21T17:26:29Z", "user_transaction_time": "2024-08-21T17:26:29Z", "issuer_payment_node": "b9a60cd41a2cc1c23090ed3666bdbf1z", "amount": 10, "currency_code": "USD", "response": { "code": "0000", "memo": "Approved or completed successfully" }, "network": "MARQETA", "subnetwork": "GATEWAY_JIT", "acquirer": { "institution_country": "840", "institution_id_code": "428399181", "retrieval_reference_number": "528294182583", "system_trace_audit_number": "656761" }, "user": { "metadata": null }, "card": { "metadata": null }, "card_security_code_verification": { "type": "CVV1", "response": { "code": "0000", "memo": "Card security code match" } }, "fraud": { "network": { "transaction_risk_score": 97, "account_risk_score": "7" } }, "pos": { "pan_entry_mode": "MAG_STRIPE", "pin_entry_mode": "TRUE", "terminal_attendance": "ATTENDED", "card_holder_presence": false, "card_presence": false, "partial_approval_capable": false, "purchase_amount_only": false, "is_recurring": false }, "transaction_metadata": { "payment_channel": "OTHER" } }, { "type": "authorization", "state": "PENDING", "token": "06a8fe88-58b1-4682-a8ad-96eb973e1d74", "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "card_token": "02cc766c-24a5-4c3b-adcf-0e5e27b09329", "gpa": { "currency_code": "USD", "ledger_balance": 20, "available_balance": 0, "credit_balance": 0, "pending_credits": 0, "impacted_amount": -10, "balances": { "USD": { "currency_code": "USD", "ledger_balance": 20, "available_balance": 0, "credit_balance": 0, "pending_credits": 0, "impacted_amount": -10 } } }, "gpa_order": { "token": "592b8164-a4af-45ee-ab24-13a4bb43e6b2", "amount": 10, "created_time": "2024-08-21T17:26:30Z", "last_modified_time": "2024-08-21T17:26:30Z", "transaction_token": "cd22cff7-2845-4508-a916-cf89fd9edae1", "state": "PENDING", "response": { "code": "0000", "memo": "Approved or completed successfully" }, "funding": { "amount": 10, "source": { "type": "programgateway", "token": "**********dd5f", "active": true, "name": "PGFS for simulating transactions", "is_default_account": false, "created_time": "2024-08-21T17:25:43Z", "last_modified_time": "2024-08-21T17:25:43Z" }, "gateway_log": { "order_number": "1200", "transaction_id": "your-jit-funding-token", "message": "Approved or completed successfully", "duration": 481, "timed_out": false, "response": { "code": "200", "data": { "jit_funding": { "token": "your-jit-funding-token", "method": "pgfs.authorization", "user_token": "your-jit-funding-user", "amount": 10, "original_jit_funding_token": "your-jit-funding-token", "address_verification": { "gateway": { "on_file": { "street_address": "2000 High St", "postal_code": "94601" }, "response": { "code": "0000", "memo": "Address and postal code match" } } } } } } }, "funding_source_token": "**********dd5f", "jit_funding": { "token": "251bdc52-588a-4291-8c5d-6ded3a67e1a8", "method": "pgfs.authorization", "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "amount": 10 }, "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "currency_code": "USD" } }, "duration": 622, "created_time": "2024-08-21T17:26:29Z", "issuer_received_time": "2024-08-21T17:26:29Z", "user_transaction_time": "2024-08-21T17:26:29Z", "settlement_date": "2024-08-21T00:00:00Z", "issuer_payment_node": "b9a60cd41a2cc1c23090ed3666bdbf1z", "request_amount": 10, "amount": 10, "currency_code": "USD", "approval_code": "761515", "response": { "code": "0000", "memo": "Approved or completed successfully" }, "network": "VISA", "subnetwork": "VISANET", "acquirer_fee_amount": 0, "acquirer": { "institution_country": "840", "institution_id_code": "428399181", "retrieval_reference_number": "528294182583", "system_trace_audit_number": "656761" }, "user": { "metadata": null }, "card": { "metadata": null }, "card_security_code_verification": { "type": "CVV1", "response": { "code": "0000", "memo": "Card security code match" } }, "fraud": { "network": { "transaction_risk_score": 97, "account_risk_score": "7" } }, "card_acceptor": { "mid": "000000000011111", "mcc": "6411", "name": "Aegis Fleet Services", "street_address": "111 Main St", "city": "Berkeley", "country_code": "USA" }, "pos": { "pan_entry_mode": "MAG_STRIPE", "pin_entry_mode": "TRUE", "terminal_id": "TR100000", "terminal_attendance": "ATTENDED", "card_holder_presence": false, "card_presence": false, "partial_approval_capable": false, "purchase_amount_only": false, "is_recurring": false }, "transaction_metadata": { "payment_channel": "OTHER" } } ] } ```

List transactions for a funding account

**Action:** `GET` **Endpoint:** `/transactions/fundingsource/{funding_source_token}` List transactions for a specific funding source. By default, this endpoint returns transactions conducted within the last 30 days. To return transactions older than 30 days, you must include the `start_date` and `end_date` query parameters in your request. By default, `GET /transactions/fundingsource/{funding_source_token}` returns transactions having either `PENDING` or `COMPLETION` states. This endpoint supports [field filtering](/core-api/field-filtering/) and [pagination](/core-api/sorting-and-pagination/).

URL path parameters

| Fields | Description | | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- | | funding\_source\_token

string

Required | The unique identifier of the funding account.

**Allowable Values:**

Existing funding source token |

URL query parameters

| Fields | Description | | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | count

integer

Optional | The number of transactions to retrieve.

**Allowable Values:**

1-100 | | start\_index

integer

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

**Allowable Values:**

Any integer | | fields

string

Optional | Comma-delimited list of fields to return (field\_1,field\_2, and so on). Leave blank to return all fields.

**Allowable Values:**

Comma-delimited list of fields, or blank | | sort\_by

string

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

**Allowable Values:**

-created\_time, created\_time, -user\_transaction\_time, user\_transaction\_time | | start\_date

string

Optional | The starting date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the start\_date and end\_date fields.

**Allowable Values:**

Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS | | end\_date

string

Optional | The ending date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the end\_date and start\_date fields.

**Allowable Values:**

Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS | | type

string

Optional | Comma-delimited list of transaction types to include.

**Allowable Values:**

- account.credit
- account.debit
- account.funding.authorization
- account.funding.authorization.reversal
- account.funding.authorization.clearing
- accountfunding.pull
- accountfunding.pull.chargeback
- accountfunding.pull.chargeback.rev
- authorization
- authorization.advice
- authorization.atm.withdrawal
- authorization.cashback
- authorization.clearing
- authorization.clearing.atm.withdrawal
- authorization.clearing.cashback
- authorization.clearing.chargeback
- authorization.clearing.chargeback.completed
- authorization.clearing.chargeback.provisional.credit
- authorization.clearing.chargeback.provisional.debit
- authorization.clearing.chargeback.reversal
- authorization.clearing.chargeback.writeoff
- authorization.clearing.quasi.cash
- authorization.incremental
- authorization.pin.change
- authorization.pin.unblock
- authorization.quasi.cash
- authorization.reversal
- authorization.reversal.issuerexpiration
- authorization.standin
- balanceinquiry
- directdeposit.credit
- directdeposit.credit.pending
- directdeposit.credit.pending.reversal
- directdeposit.credit.reject
- directdeposit.credit.reversal
- directdeposit.debit
- directdeposit.debit.pending
- directdeposit.debit.pending.reversal
- directdeposit.debit.reject
- directdeposit.debit.reversal
- dispute.credit
- dispute.debit
- fee.charge
- fee.charge.pending
- fee.charge.pending.refund
- fee.charge.reversal
- funds.expire
- gpa.credit
- gpa.credit.authorization
- gpa.credit.authorization.billpayment
- gpa.credit.authorization.billpayment.reversal
- gpa.credit.authorization.reversal
- gpa.credit.billpayment
- gpa.credit.chargeback
- gpa.credit.chargeback.reversal
- gpa.credit.issueroperator
- gpa.credit.pending
- gpa.credit.pending.reversal
- gpa.credit.reversal
- gpa.credit.networkload
- gpa.credit.networkload.reversal
- gpa.debit
- gpa.debit.issueroperator
- gpa.debit.networkload
- gpa.debit.pending
- gpa.debit.pending.reversal
- gpa.debit.reversal
- gpa.grant
- original.credit.authorization
- original.credit.authorization.clearing
- original.credit.authorization.reversal
- original.credit.auth\_plus\_capture
- original.credit.auth\_plus\_capture.reversal
- pin.change.reversal
- pin.change.reversal.advice
- pindebit
- pindebit.atm.withdrawal
- pindebit.authorization
- pindebit.authorization.clearing
- pindebit.authorization.reversal
- pindebit.authorization.reversal.issuerexpiration
- pindebit.balanceinquiry
- pindebit.cashback
- pindebit.chargeback
- pindebit.chargeback.completed
- pindebit.chargeback.provisional.credit
- pindebit.chargeback.provisional.debit
- pindebit.chargeback.reversal
- pindebit.chargeback.writeoff
- pindebit.credit.adjustment
- pindebit.pin.change
- pindebit.pin.unblock
- pindebit.quasicash
- pindebit.refund
- pindebit.refund.reversal
- pindebit.reversal
- pindebit.transfer
- product.inquiry
- programreserve.credit
- programreserve.debit
- pullfromcard.pull
- pullfromcard.pull.chargeback
- pullfromcard.pull.chargeback.rev
- pullfromcard.pull.reversal
- pushtocard.debit
- pushtocard.reversal
- refund
- refund.authorization
- refund.authorization.advice
- refund.authorization.clearing
- refund.authorization.reversal
- reward.earn
- token.activation-request
- token.advice
- transfer.fee
- transfer.peer
- transfer.program
- transit.offer
- unknown | | polarity

string

Optional | Specifies whether to return credit or debit transactions.

**Allowable Values:**

CREDIT, DEBIT, PENDING\_CREDIT, PENDING\_DEBIT | | version

string

Optional | Specifies the API version for the request.

**Allowable Values:**

v1, v2, v3 |

Response body

| Fields | Description | | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | count

integer

Conditionally returned | The number of resources to retrieve.

This field is returned if there are resources in your returned array.

**Allowable Values:**

1-10 | | data

array of objects

Conditionally returned | An array of transaction objects. See the Transaction object description at the top of this page.

Objects are returned as appropriate to your query.

**Allowable Values:**

Valid array of one or more transaction objects | | end\_index

integer

Conditionally returned | The sort order index of the last resource in the returned array.

This field is returned if there are resources in your returned array.

**Allowable Values:**

Any integer | | is\_more

boolean

Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.

This field is returned if there are resources in your returned array.

**Allowable Values:**

true, false | | start\_index

integer

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

This field is returned if there are resources in your returned array.

**Allowable Values:**

Any integer |

Retrieve transaction

**Action:** `GET` **Endpoint:** `/transactions/{token}` Retrieve a specific transaction. Include the `token` path parameter to identify the transaction. **Note** Transactions are not available in real time via this endpoint, and typically appear after 30 seconds. On occasion, a transaction may require up to four hours to appear.

URL path parameters

| Fields | Description | | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | token

string

Required | The unique identifier of the transaction.

**Allowable Values:**

Existing transaction token |

URL query parameters

| Fields | Description | | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | fields

string

Optional | Comma-delimited list of fields to return (field\_1,field\_2, and so on). Leave blank to return all fields.

**Allowable Values:**

Comma-delimited list of fields, or blank | | version

string

Optional | Specifies the API version for the request.

**Allowable Values:**

v1, v2, v3 |

Response body

See [Transaction object](/core-api/transactions/#transaction_model).

Sample response body

```json JSON expandable lines wrap theme={null} { "type": "authorization", "state": "PENDING", "token": "06a8fe88-58b1-4682-a8ad-96eb973e1d74", "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "card_token": "02cc766c-24a5-4c3b-adcf-0e5e27b09329", "gpa": { "currency_code": "USD", "ledger_balance": 20, "available_balance": 0, "credit_balance": 0, "pending_credits": 0, "impacted_amount": -10, "balances": { "USD": { "currency_code": "USD", "ledger_balance": 20, "available_balance": 0, "credit_balance": 0, "pending_credits": 0, "impacted_amount": -10 } } }, "gpa_order": { "token": "592b8164-a4af-45ee-ab24-13a4bb43e6b2", "amount": 10, "created_time": "2024-08-21T17:26:30Z", "last_modified_time": "2024-08-21T17:26:30Z", "transaction_token": "cd22cff7-2845-4508-a916-cf89fd9edae1", "state": "PENDING", "response": { "code": "0000", "memo": "Approved or completed successfully" }, "funding": { "amount": 10, "source": { "type": "programgateway", "token": "**********dd5f", "active": true, "name": "PGFS for simulating transactions", "is_default_account": false, "created_time": "2024-08-21T17:25:43Z", "last_modified_time": "2024-08-21T17:25:43Z" }, "gateway_log": { "order_number": "1200", "transaction_id": "your-jit-funding-token", "message": "Approved or completed successfully", "duration": 481, "timed_out": false, "response": { "code": "200", "data": [ { "jit_funding": { "token": "your-jit-funding-token", "method": "pgfs.authorization", "user_token": "your-jit-funding-user", "amount": 10, "original_jit_funding_token": "your-jit-funding-token", "address_verification": { "gateway": { "on_file": { "street_address": "2000 High St", "postal_code": "94601" }, "response": { "code": "0000", "memo": "Address and postal code match" } } } } } ] } } }, "funding_source_token": "**********dd5f", "jit_funding": { "token": "251bdc52-588a-4291-8c5d-6ded3a67e1a8", "method": "pgfs.authorization", "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "amount": 10 }, "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "currency_code": "USD" }, "duration": 622, "created_time": "2024-08-21T17:26:29Z", "user_transaction_time": "2024-08-21T17:26:29Z", "issuer_received_time": "2024-08-21T17:26:29Z", "settlement_date": "2024-08-21T00:00:00Z", "issuer_payment_node": "b9a60cd41a2cc1c23090ed3666bdbf1z", "request_amount": 10, "amount": 10, "currency_conversion": { "network": { "original_amount": 10, "conversion_rate": 1, "original_currency_code": "840", "dynamic_currency_conversion": false } }, "currency_code": "USD", "approval_code": "761515", "response": { "code": "0000", "memo": "Approved or completed successfully" }, "network": "VISA", "subnetwork": "VISANET", "acquirer_fee_amount": 0, "acquirer": { "institution_country": "840", "institution_id_code": "428399181", "retrieval_reference_number": "528294182583", "system_trace_audit_number": "656761" }, "user": { "metadata": null }, "card": { "metadata": null }, "card_security_code_verification": { "type": "CVV1", "response": { "code": "0000", "memo": "Card security code match" } }, "fraud": { "network": { "transaction_risk_score": 97, "account_risk_score": "7" } }, "cardholder_authentication_data": { "electronic_commerce_indicator": "authentication_successful", "verification_result": "verified", "verification_value_created_by": "issuer_acs" }, "card_acceptor": { "mid": "000000000011111", "mcc": "6411", "name": "Aegis Fleet Services", "street_address": "111 Main St", "city": "Berkeley", "country_code": "USA" }, "pos": { "pan_entry_mode": "MAG_STRIPE", "pin_entry_mode": "TRUE", "terminal_id": "TR100000", "terminal_attendance": "ATTENDED", "card_holder_presence": false, "card_presence": false, "partial_approval_capable": false, "purchase_amount_only": false, "is_recurring": false }, "transaction_metadata": { "payment_channel": "OTHER" } } ``` **Action:** `GET` **Endpoint:** `/transactions/{token}/related` List all transactions related to the specified transaction. By default, this endpoint returns transactions conducted within the last 30 days. To return transactions older than 30 days, you must include the `start_date` and `end_date` query parameters in your request. By default, this endpoint returns transactions of any state. To return transactions in specific states, you must include the `state` query parameter in your request. This endpoint supports [field filtering](/core-api/field-filtering/) and [pagination](/core-api/sorting-and-pagination/).

URL path parameters

| Fields | Description | | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | token

string

Required | The unique identifier of the transaction.

**Allowable Values:**

Existing transaction token |

URL query parameters

| Fields | Description | | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | count

integer

Optional | The number of transactions to retrieve.

**Allowable Values:**

1-100 | | start\_index

integer

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

**Allowable Values:**

Any integer | | fields

string

Optional | Comma-delimited list of fields to return (field\_1,field\_2, and so on). Leave blank to return all fields.

**Allowable Values:**

Comma-delimited list of fields, or blank | | sort\_by

string

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

**Allowable Values:**

-created\_time, created\_time, -user\_transaction\_time, user\_transaction\_time | | start\_date

string

Optional | The starting date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the start\_date and end\_date fields.

**Allowable Values:**

Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS | | end\_date

string

Optional | The ending date (or date-time) of a date range from which to return transactions. To return transactions for a single day, enter the same date in both the end\_date and start\_date fields.

**Allowable Values:**

Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ss.SS | | type

string

Optional | Comma-delimited list of transaction types to include.

**Allowable Values:**

- account.credit
- account.debit
- account.funding.authorization
- account.funding.authorization.reversal
- account.funding.authorization.clearing
- accountfunding.pull
- accountfunding.pull.chargeback
- accountfunding.pull.chargeback.rev
- authorization
- authorization.advice
- authorization.atm.withdrawal
- authorization.cashback
- authorization.clearing
- authorization.clearing.atm.withdrawal
- authorization.clearing.cashback
- authorization.clearing.chargeback
- authorization.clearing.chargeback.completed
- authorization.clearing.chargeback.provisional.credit
- authorization.clearing.chargeback.provisional.debit
- authorization.clearing.chargeback.reversal
- authorization.clearing.chargeback.writeoff
- authorization.clearing.quasi.cash
- authorization.incremental
- authorization.pin.change
- authorization.pin.unblock
- authorization.quasi.cash
- authorization.reversal
- authorization.reversal.issuerexpiration
- authorization.standin
- balanceinquiry
- directdeposit.credit
- directdeposit.credit.pending
- directdeposit.credit.pending.reversal
- directdeposit.credit.reject
- directdeposit.credit.reversal
- directdeposit.debit
- directdeposit.debit.pending
- directdeposit.debit.pending.reversal
- directdeposit.debit.reject
- directdeposit.debit.reversal
- dispute.credit
- dispute.debit
- fee.charge
- fee.charge.pending
- fee.charge.pending.refund
- fee.charge.reversal
- funds.expire
- gpa.credit
- gpa.credit.authorization
- gpa.credit.authorization.billpayment
- gpa.credit.authorization.billpayment.reversal
- gpa.credit.authorization.reversal
- gpa.credit.billpayment
- gpa.credit.chargeback
- gpa.credit.chargeback.reversal
- gpa.credit.issueroperator
- gpa.credit.pending
- gpa.credit.pending.reversal
- gpa.credit.reversal
- gpa.credit.networkload
- gpa.credit.networkload.reversal
- gpa.debit
- gpa.debit.issueroperator
- gpa.debit.networkload
- gpa.debit.pending
- gpa.debit.pending.reversal
- gpa.debit.reversal
- gpa.grant
- original.credit.authorization
- original.credit.authorization.clearing
- original.credit.authorization.reversal
- original.credit.auth\_plus\_capture
- original.credit.auth\_plus\_capture.reversal
- pin.change.reversal
- pin.change.reversal.advice
- pindebit
- pindebit.atm.withdrawal
- pindebit.authorization
- pindebit.authorization.clearing
- pindebit.authorization.reversal
- pindebit.authorization.reversal.issuerexpiration
- pindebit.balanceinquiry
- pindebit.cashback
- pindebit.chargeback
- pindebit.chargeback.completed
- pindebit.chargeback.provisional.credit
- pindebit.chargeback.provisional.debit
- pindebit.chargeback.reversal
- pindebit.chargeback.writeoff
- pindebit.credit.adjustment
- pindebit.pin.change
- pindebit.pin.unblock
- pindebit.quasicash
- pindebit.refund
- pindebit.refund.reversal
- pindebit.reversal
- pindebit.transfer
- product.inquiry
- programreserve.credit
- programreserve.debit
- pullfromcard.pull
- pullfromcard.pull.chargeback
- pullfromcard.pull.chargeback.rev
- pullfromcard.pull.reversal
- pushtocard.debit
- pushtocard.reversal
- refund
- refund.authorization
- refund.authorization.advice
- refund.authorization.clearing
- refund.authorization.reversal
- reward.earn
- token.activation-request
- token.advice
- transfer.fee
- transfer.peer
- transfer.program
- transit.offer
- unknown | | state

string

Optional | Comma-delimited list of transaction states to display.

**Allowable Values:**

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL | | version

string

Optional | Specifies the API version for the request.

**Allowable Values:**

v1, v2, v3 |

Response body

| Fields | Description | | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | count

integer

Conditionally returned | The number of resources to retrieve.

This field is returned if there are resources in your returned array.

**Allowable Values:**

1-10 | | data

array of objects

Conditionally returned | An array of transaction objects. See the Transaction object description at the top of this page.

Objects are returned as appropriate to your query.

**Allowable Values:**

Valid array of one or more transaction objects | | end\_index

integer

Conditionally returned | The sort order index of the last resource in the returned array.

This field is returned if there are resources in your returned array.

**Allowable Values:**

Any integer | | is\_more

boolean

Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.

This field is returned if there are resources in your returned array.

**Allowable Values:**

true, false | | start\_index

integer

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

This field is returned if there are resources in your returned array.

**Allowable Values:**

Any integer |

Sample response body

```json JSON expandable lines wrap theme={null} { "count": 1, "start_index": 0, "end_index": 0, "is_more": false, "data": [ { "type": "gpa.credit.authorization", "state": "PENDING", "token": "cd22cff7-2845-4508-a916-cf89fd9edae1", "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "card_token": "02cc766c-24a5-4c3b-adcf-0e5e27b09329", "preceding_related_transaction_token": "06a8fe88-58b1-4682-a8ad-96eb973e1d74", "gpa": { "currency_code": "USD", "ledger_balance": 20, "available_balance": 0, "credit_balance": 0, "pending_credits": 0, "impacted_amount": 10, "balances": { "USD": { "currency_code": "USD", "ledger_balance": 20, "available_balance": 0, "credit_balance": 0, "pending_credits": 0, "impacted_amount": 10 } } }, "gpa_order": { "token": "592b8164-a4af-45ee-ab24-13a4bb43e6b2", "amount": 10, "created_time": "2024-08-21T17:26:30Z", "last_modified_time": "2024-08-21T17:26:30Z", "transaction_token": "cd22cff7-2845-4508-a916-cf89fd9edae1", "state": "PENDING", "response": { "code": "0000", "memo": "Approved or completed successfully" }, "funding": { "amount": 10, "source": { "type": "programgateway", "token": "**********dd5f", "active": true, "name": "PGFS for simulating transactions", "is_default_account": false, "created_time": "2024-08-21T17:25:43Z", "last_modified_time": "2024-08-21T17:25:43Z" }, "gateway_log": { "order_number": "1200", "transaction_id": "your-jit-funding-token", "message": "Approved or completed successfully", "duration": 481, "timed_out": false, "response": { "code": "200", "data": { "jit_funding": { "token": "your-jit-funding-token", "method": "pgfs.authorization", "user_token": "your-jit-funding-user", "amount": 10, "original_jit_funding_token": "your-jit-funding-token", "address_verification": { "gateway": { "on_file": { "street_address": "2000 High St", "postal_code": 94601 }, "response": { "code": "0000", "memo": "Address and postal code match" } } } } } } }, "funding_source_token": "**********dd5f", "jit_funding": { "token": "251bdc52-588a-4291-8c5d-6ded3a67e1a8", "method": "pgfs.authorization", "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "acting_user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "amount": 10 }, "user_token": "99f323d4-298f-4b0c-93b1-19b2d9921eb8", "currency_code": "USD" } }, "duration": 537, "created_time": "2024-08-21T17:26:29Z", "issuer_received_time": "2024-08-21T17:26:29Z", "user_transaction_time": "2024-08-21T17:26:29Z", "issuer_payment_node": "b9a60cd41a2cc1c23090ed3666bdbf1z", "amount": 10, "currency_code": "USD", "response": { "code": "0000", "memo": "Approved or completed successfully" }, "network": "MARQETA", "subnetwork": "GATEWAY_JIT", "acquirer": { "institution_country": "840", "institution_id_code": "428399181", "retrieval_reference_number": "528294182583", "system_trace_audit_number": "656761" }, "user": { "metadata": null }, "card": { "metadata": null }, "card_security_code_verification": { "type": "CVV1", "response": { "code": "0000", "memo": "Card security code match" } }, "fraud": { "network": { "transaction_risk_score": 97, "account_risk_score": "7" } }, "pos": { "pan_entry_mode": "MAG_STRIPE", "pin_entry_mode": "TRUE", "terminal_attendance": "ATTENDED", "card_holder_presence": false, "card_presence": false, "partial_approval_capable": false, "purchase_amount_only": false, "is_recurring": false }, "transaction_metadata": { "payment_channel": "OTHER" } } ] } ``` ## Related topics - [About Transactions](/docs/developer-guides/about-transactions.md) - [Transactions Overview](/docs/developer-guides/transactions-landing-page.md) - [Simulating Transactions](/docs/core-api/simulating-transactions.md) - [Simulations 2.0 — Card Transactions](/docs/core-api/simulations-card-transactions.md) - [Transaction Processing in Europe](/docs/developer-guides/mq-eu-transaction-processing.md)